software.amazon.awssdk.services.kinesisvideo.model

Class UpdateDataRetentionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesisvideo.model.KinesisVideoRequest

software.amazon.awssdk.services.kinesisvideo.model.UpdateDataRetentionRequest

All Implemented Interfaces:

ToCopyableBuilder<UpdateDataRetentionRequest.Builder,UpdateDataRetentionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class UpdateDataRetentionRequest
extends KinesisVideoRequest
implements ToCopyableBuilder<UpdateDataRetentionRequest.Builder,UpdateDataRetentionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateDataRetentionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateDataRetentionRequest.Builder	builder()
String	currentVersion() The version of the stream whose retention period you want to change.
Integer	dataRetentionChangeInHours() The retention period, in hours.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
UpdateDataRetentionOperation	operation() Indicates whether you want to increase or decrease the retention period.
String	operationAsString() Indicates whether you want to increase or decrease the retention period.
static Class<? extends UpdateDataRetentionRequest.Builder>	serializableBuilderClass()
String	streamARN() The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
String	streamName() The name of the stream whose retention period you want to change.
UpdateDataRetentionRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

streamName

public String streamName()

The name of the stream whose retention period you want to change.

Returns:

The name of the stream whose retention period you want to change.

streamARN

public String streamARN()

The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

Returns:

The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

currentVersion

public String currentVersion()

The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

Returns:

The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

operation

public UpdateDataRetentionOperation operation()

Indicates whether you want to increase or decrease the retention period.

If the service returns an enum value that is not available in the current SDK version, operation will return UpdateDataRetentionOperation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

Returns:

Indicates whether you want to increase or decrease the retention period.

See Also:

UpdateDataRetentionOperation

operationAsString

public String operationAsString()

Indicates whether you want to increase or decrease the retention period.

If the service returns an enum value that is not available in the current SDK version, operation will return UpdateDataRetentionOperation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

Returns:

Indicates whether you want to increase or decrease the retention period.

See Also:

UpdateDataRetentionOperation

dataRetentionChangeInHours

public Integer dataRetentionChangeInHours()

The retention period, in hours. The value you specify replaces the current value.

Returns:

The retention period, in hours. The value you specify replaces the current value.

toBuilder

public UpdateDataRetentionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDataRetentionRequest.Builder,UpdateDataRetentionRequest>

Specified by:

toBuilder in class KinesisVideoRequest

Returns:

a builder for type T

builder

public static UpdateDataRetentionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateDataRetentionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value