@Generated(value="software.amazon.awssdk:codegen") public class GetShardIteratorRequest extends DynamoDBStreamsRequest implements ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>
Represents the input of a GetShardIterator
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
GetShardIteratorRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static GetShardIteratorRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
sequenceNumber()
The sequence number of a stream record in the shard from which to start reading.
|
static Class<? extends GetShardIteratorRequest.Builder> |
serializableBuilderClass() |
String |
shardId()
The identifier of the shard.
|
ShardIteratorType |
shardIteratorType()
Determines how the shard iterator is used to start reading stream records from the shard:
|
String |
shardIteratorTypeString()
Determines how the shard iterator is used to start reading stream records from the shard:
|
String |
streamArn()
The Amazon Resource Name (ARN) for the stream.
|
GetShardIteratorRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String streamArn()
The Amazon Resource Name (ARN) for the stream.
public String shardId()
The identifier of the shard. The iterator will be returned for this shard ID.
public 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 shardIteratorTypeString()
.
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 shardIteratorTypeString()
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 shardIteratorTypeString()
.
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 sequenceNumber()
The sequence number of a stream record in the shard from which to start reading.
public GetShardIteratorRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>
toBuilder
in class DynamoDBStreamsRequest
public static GetShardIteratorRequest.Builder builder()
public static Class<? extends GetShardIteratorRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.