@Generated(value="software.amazon.awssdk:codegen") public class GetShardIteratorRequest extends KinesisRequest implements ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>
Represents the input for GetShardIterator
.
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() |
static Class<? extends GetShardIteratorRequest.Builder> |
serializableBuilderClass() |
String |
shardId()
The shard ID of the Kinesis Streams shard to get the iterator for.
|
ShardIteratorType |
shardIteratorType()
Determines how the shard iterator is used to start reading data records from the shard.
|
String |
shardIteratorTypeString()
Determines how the shard iterator is used to start reading data records from the shard.
|
String |
startingSequenceNumber()
The sequence number of the data record in the shard from which to start reading.
|
String |
streamName()
The name of the Amazon Kinesis stream.
|
Instant |
timestamp()
The time stamp of the data record from which to start reading.
|
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 streamName()
The name of the Amazon Kinesis stream.
public String shardId()
The shard ID of the Kinesis Streams shard to get the iterator for.
public ShardIteratorType shardIteratorType()
Determines how the shard iterator is used to start reading data records from the shard.
The following are the valid Amazon Kinesis shard iterator types:
AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value
StartingSequenceNumber
.
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in
the value StartingSequenceNumber
.
AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value
Timestamp
.
TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.
LATEST - Start reading just after the most recent 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()
.
The following are the valid Amazon Kinesis shard iterator types:
AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in
the value StartingSequenceNumber
.
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number,
provided in the value StartingSequenceNumber
.
AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value
Timestamp
.
TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.
LATEST - Start reading just after the most recent 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 data records from the shard.
The following are the valid Amazon Kinesis shard iterator types:
AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value
StartingSequenceNumber
.
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in
the value StartingSequenceNumber
.
AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value
Timestamp
.
TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.
LATEST - Start reading just after the most recent 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()
.
The following are the valid Amazon Kinesis shard iterator types:
AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in
the value StartingSequenceNumber
.
AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number,
provided in the value StartingSequenceNumber
.
AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value
Timestamp
.
TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.
LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.
ShardIteratorType
public String startingSequenceNumber()
The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.
public Instant timestamp()
The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time
stamp is the Unix epoch date with precision in milliseconds. For example,
2016-04-04T19:58:46.480-00:00
or 1459799926.480
. If a record with this exact time stamp
does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current
trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
2016-04-04T19:58:46.480-00:00
or 1459799926.480
. If a record with this exact
time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is
older than the current trim horizon, the iterator returned is for the oldest untrimmed data record
(TRIM_HORIZON).public GetShardIteratorRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>
toBuilder
in class KinesisRequest
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.