Class GetShardIteratorRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input of a GetShardIterator operation.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The sequence number of a stream record in the shard from which to start reading.The identifier of the shard.Determines how the shard iterator is used to start reading stream records from the shard:The Amazon Resource Name (ARN) for the stream.int
hashCode()
void
setSequenceNumber
(String sequenceNumber) The sequence number of a stream record in the shard from which to start reading.void
setShardId
(String shardId) The identifier of the shard.void
setShardIteratorType
(ShardIteratorType shardIteratorType) Determines how the shard iterator is used to start reading stream records from the shard:void
setShardIteratorType
(String shardIteratorType) Determines how the shard iterator is used to start reading stream records from the shard:void
setStreamArn
(String streamArn) The Amazon Resource Name (ARN) for the stream.toString()
Returns a string representation of this object; useful for testing and debugging.withSequenceNumber
(String sequenceNumber) The sequence number of a stream record in the shard from which to start reading.withShardId
(String shardId) The identifier of the shard.withShardIteratorType
(ShardIteratorType shardIteratorType) Determines how the shard iterator is used to start reading stream records from the shard:withShardIteratorType
(String shardIteratorType) Determines how the shard iterator is used to start reading stream records from the shard:withStreamArn
(String streamArn) The Amazon Resource Name (ARN) for the stream.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
GetShardIteratorRequest
public GetShardIteratorRequest()
-
-
Method Details
-
setStreamArn
The Amazon Resource Name (ARN) for the stream.
- Parameters:
streamArn
- The Amazon Resource Name (ARN) for the stream.
-
getStreamArn
The Amazon Resource Name (ARN) for the stream.
- Returns:
- The Amazon Resource Name (ARN) for the stream.
-
withStreamArn
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
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
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
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-