Package software.amazon.awssdk.services.dynamodb.model

Class GetShardIteratorRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.dynamodb.model.DynamoDbStreamsRequest
software.amazon.awssdk.services.dynamodb.model.GetShardIteratorRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetShardIteratorRequest extends DynamoDbStreamsRequest implements ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>

Represents the input of a GetShardIterator operation.

  • Method Details

    • streamArn

      public final String streamArn()

      The Amazon Resource Name (ARN) for the stream.

      Returns:
      The Amazon Resource Name (ARN) for the stream.

    • shardId

      public final String shardId()

      The identifier of the shard. The iterator will be returned for this shard ID.

      Returns:
      The identifier of the shard. The iterator will be returned for this shard ID.

    • shardIteratorType

      public final ShardIteratorType shardIteratorType()

      Determines how the shard iterator is used to start reading stream records from the shard:

      • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

      • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

      • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

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

      Returns:
      Determines how the shard iterator is used to start reading stream records from the shard:

      • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

      • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

      • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

      See Also:

    • shardIteratorTypeAsString

      public final String shardIteratorTypeAsString()

      Determines how the shard iterator is used to start reading stream records from the shard:

      • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

      • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

      • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

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

      Returns:
      Determines how the shard iterator is used to start reading stream records from the shard:

      • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

      • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

      • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

      See Also:

    • sequenceNumber

      public final String sequenceNumber()

      The sequence number of a stream record in the shard from which to start reading.

      Returns:
      The sequence number of a stream record in the shard from which to start reading.

    • toBuilder

      public GetShardIteratorRequest.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<GetShardIteratorRequest.Builder,GetShardIteratorRequest>
      Specified by:
      toBuilder in class DynamoDbStreamsRequest
      Returns:
      a builder for type T

    • builder

      public static GetShardIteratorRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetShardIteratorRequest.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.