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>

  • Method Details

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

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

    • 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()
      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 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.