Class GetShardIteratorRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.dynamodbv2.model.GetShardIteratorRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the input of a GetShardIterator operation.

See Also:
  • Constructor Details

    • GetShardIteratorRequest

      public GetShardIteratorRequest()
  • Method Details

    • setStreamArn

      public void setStreamArn(String streamArn)

      The Amazon Resource Name (ARN) for the stream.

      Parameters:
      streamArn - The Amazon Resource Name (ARN) for the stream.
    • getStreamArn

      public String getStreamArn()

      The Amazon Resource Name (ARN) for the stream.

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

      public GetShardIteratorRequest withStreamArn(String streamArn)

      The Amazon Resource Name (ARN) for the stream.

      Parameters:
      streamArn - The Amazon Resource Name (ARN) for the stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setShardId

      public void setShardId(String shardId)

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

      Parameters:
      shardId - The identifier of the shard. The iterator will be returned for this shard ID.
    • getShardId

      public String getShardId()

      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.
    • withShardId

      public GetShardIteratorRequest withShardId(String shardId)

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

      Parameters:
      shardId - The identifier of the shard. The iterator will be returned for this shard ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setShardIteratorType

      public void setShardIteratorType(String 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.

      Parameters:
      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.

      See Also:
    • getShardIteratorType

      public String getShardIteratorType()

      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.

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

      public GetShardIteratorRequest withShardIteratorType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setShardIteratorType

      public void setShardIteratorType(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.

      Parameters:
      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.

      See Also:
    • withShardIteratorType

      public GetShardIteratorRequest withShardIteratorType(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setSequenceNumber

      public void setSequenceNumber(String sequenceNumber)

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

      Parameters:
      sequenceNumber - The sequence number of a stream record in the shard from which to start reading.
    • getSequenceNumber

      public String getSequenceNumber()

      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.
    • withSequenceNumber

      public GetShardIteratorRequest withSequenceNumber(String sequenceNumber)

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

      Parameters:
      sequenceNumber - The sequence number of a stream record in the shard from which to start reading.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public GetShardIteratorRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: