Package software.amazon.awssdk.services.kinesis.model

Class GetShardIteratorRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.kinesis.model.GetShardIteratorRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>

@Generated("software.amazon.awssdk:codegen")
public class GetShardIteratorRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>

Represents the input for GetShardIterator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetShardIteratorRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static GetShardIteratorRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
static Class<? extends GetShardIteratorRequest.Builder>	serializableBuilderClass()
String	shardId()	The shard ID of the Amazon Kinesis shard to get the iterator for.
String	shardIteratorType()	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.
Date	timestamp()	The timestamp 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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

streamName

public String streamName()

The name of the Amazon Kinesis stream.

Returns:

The name of the Amazon Kinesis stream.

shardId

public String shardId()

The shard ID of the Amazon Kinesis shard to get the iterator for.

Returns:

The shard ID of the Amazon Kinesis shard to get the iterator for.

shardIteratorType

public String 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 timestamp, 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.

Returns:

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 timestamp, 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.

See Also:

ShardIteratorType

startingSequenceNumber

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.

Returns:

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.

timestamp

public Date timestamp()

The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A timestamp 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 timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Returns:

The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A timestamp 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 timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

toBuilder

public GetShardIteratorRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>

Returns:

a builder for type T

builder

public static GetShardIteratorRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetShardIteratorRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object