Class UpdateDataRetentionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateDataRetentionRequest.Builder,
UpdateDataRetentionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The version of the stream whose retention period you want to change.final Integer
The number of hours to adjust the current retention by.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
Indicates whether you want to increase or decrease the retention period.final String
Indicates whether you want to increase or decrease the retention period.static Class
<? extends UpdateDataRetentionRequest.Builder> final String
The Amazon Resource Name (ARN) of the stream whose retention period you want to change.final String
The name of the stream whose retention period you want to change.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The version of the stream whose retention period you want to change. To get the version, call either the
DescribeStream
or theListStreams
API.- Returns:
- The version of the stream whose retention period you want to change. To get the version, call either the
DescribeStream
or theListStreams
API.
-
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 returnUpdateDataRetentionOperation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperationAsString()
.- Returns:
- Indicates whether you want to increase or decrease the retention period.
- See Also:
-
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 returnUpdateDataRetentionOperation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperationAsString()
.- Returns:
- Indicates whether you want to increase or decrease the retention period.
- See Also:
-
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
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 interfaceToCopyableBuilder<UpdateDataRetentionRequest.Builder,
UpdateDataRetentionRequest> - Specified by:
toBuilder
in classKinesisVideoRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFields
-