Package 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:

SdkPojo, ToCopyableBuilder<UpdateDataRetentionRequest.Builder,UpdateDataRetentionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateDataRetentionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateDataRetentionRequest.Builder	builder()
String	currentVersion()	The version of the stream whose retention period you want to change.
Integer	dataRetentionChangeInHours()	The number of hours to adjust the current retention by.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
List<SdkField<?>>	sdkFields()
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()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

streamName

public final 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 final 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 final 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 final 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 final 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 final Integer dataRetentionChangeInHours()

The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the operation.

The minimum value for data retention is 0 and the maximum value is 87600 (ten years).

Returns:

The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the operation.

The minimum value for data retention is 0 and the maximum value is 87600 (ten years).

toBuilder

public UpdateDataRetentionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDataRetentionRequest.Builder,UpdateDataRetentionRequest>

Specified by:

toBuilder in class KinesisVideoRequest

builder

public static UpdateDataRetentionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo