public class GetShardIteratorRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the input of a GetShardIterator operation.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
sequenceNumber
The sequence number of a stream record in the shard from which to start
reading.
|
private java.lang.String |
shardId
The identifier of the shard.
|
private java.lang.String |
shardIteratorType
Determines how the shard iterator is used to start reading stream records
from the shard:
|
private java.lang.String |
streamArn
The Amazon Resource Name (ARN) for the stream.
|
NOOP
Constructor and Description |
---|
GetShardIteratorRequest() |
Modifier and Type | Method and Description |
---|---|
GetShardIteratorRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getSequenceNumber()
The sequence number of a stream record in the shard from which to start
reading.
|
java.lang.String |
getShardId()
The identifier of the shard.
|
java.lang.String |
getShardIteratorType()
Determines how the shard iterator is used to start reading stream records
from the shard:
|
java.lang.String |
getStreamArn()
The Amazon Resource Name (ARN) for the stream.
|
int |
hashCode() |
void |
setSequenceNumber(java.lang.String sequenceNumber)
The sequence number of a stream record in the shard from which to start
reading.
|
void |
setShardId(java.lang.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(java.lang.String shardIteratorType)
Determines how the shard iterator is used to start reading stream records
from the shard:
|
void |
setStreamArn(java.lang.String streamArn)
The Amazon Resource Name (ARN) for the stream.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
GetShardIteratorRequest |
withSequenceNumber(java.lang.String sequenceNumber)
The sequence number of a stream record in the shard from which to start
reading.
|
GetShardIteratorRequest |
withShardId(java.lang.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(java.lang.String shardIteratorType)
Determines how the shard iterator is used to start reading stream records
from the shard:
|
GetShardIteratorRequest |
withStreamArn(java.lang.String streamArn)
The Amazon Resource Name (ARN) for the stream.
|
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
private java.lang.String streamArn
The Amazon Resource Name (ARN) for the stream.
private java.lang.String shardId
The identifier of the shard. The iterator will be returned for this shard ID.
private java.lang.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.
private java.lang.String sequenceNumber
The sequence number of a stream record in the shard from which to start reading.
public void setStreamArn(java.lang.String streamArn)
The Amazon Resource Name (ARN) for the stream.
streamArn
- The Amazon Resource Name (ARN) for the stream.public java.lang.String getStreamArn()
The Amazon Resource Name (ARN) for the stream.
public GetShardIteratorRequest withStreamArn(java.lang.String streamArn)
The Amazon Resource Name (ARN) for the stream.
streamArn
- The Amazon Resource Name (ARN) for the stream.public void setShardId(java.lang.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 java.lang.String getShardId()
The identifier of the shard. The iterator will be returned for this shard ID.
public GetShardIteratorRequest withShardId(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.String getSequenceNumber()
The sequence number of a stream record in the shard from which to start reading.
public GetShardIteratorRequest withSequenceNumber(java.lang.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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public GetShardIteratorRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()