@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a GetShardIterator
operation.
NOOP
Constructor and Description |
---|
GetShardIteratorRequest() |
Modifier and Type | Method and Description |
---|---|
GetShardIteratorRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getSequenceNumber()
The sequence number of a stream record in the shard from which to start reading.
|
String |
getShardId()
The identifier of the shard.
|
String |
getShardIteratorType()
Determines how the shard iterator is used to start reading stream records from the shard:
|
String |
getStreamArn()
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.
|
String |
toString()
Returns a string representation of this object.
|
GetShardIteratorRequest |
withSequenceNumber(String sequenceNumber)
The sequence number of a stream record in the shard from which to start reading.
|
GetShardIteratorRequest |
withShardId(String shardId)
The identifier of the shard.
|
GetShardIteratorRequest |
withShardIteratorType(ShardIteratorType shardIteratorType)
Determines how the shard iterator is used to start reading stream records from the shard:
|
GetShardIteratorRequest |
withShardIteratorType(String shardIteratorType)
Determines how the shard iterator is used to start reading stream records from the shard:
|
GetShardIteratorRequest |
withStreamArn(String streamArn)
The Amazon Resource Name (ARN) for the stream.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setStreamArn(String streamArn)
The Amazon Resource Name (ARN) for the stream.
streamArn
- The Amazon Resource Name (ARN) for the stream.public String getStreamArn()
The Amazon Resource Name (ARN) for the stream.
public GetShardIteratorRequest withStreamArn(String streamArn)
The Amazon Resource Name (ARN) for the stream.
streamArn
- The Amazon Resource Name (ARN) for the stream.public void setShardId(String shardId)
The identifier of the shard. The iterator will be returned for this shard ID.
shardId
- The identifier of the shard. The iterator will be returned for this shard ID.public String getShardId()
The identifier of the shard. The iterator will be returned for this shard ID.
public GetShardIteratorRequest withShardId(String shardId)
The identifier of the shard. The iterator will be returned for this shard ID.
shardId
- The identifier of the shard. The iterator will be returned for this shard ID.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.
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.
ShardIteratorType
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.
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.
ShardIteratorType
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.
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.
ShardIteratorType
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.
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.
ShardIteratorType
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.
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.
ShardIteratorType
public void setSequenceNumber(String sequenceNumber)
The sequence number of a stream record in the shard from which to start reading.
sequenceNumber
- The sequence number of a stream record in the shard from which to start reading.public String getSequenceNumber()
The sequence number of a stream record in the shard from which to start reading.
public GetShardIteratorRequest withSequenceNumber(String sequenceNumber)
The sequence number of a stream record in the shard from which to start reading.
sequenceNumber
- The sequence number of a stream record in the shard from which to start reading.public String toString()
toString
in class Object
Object.toString()
public GetShardIteratorRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()