Package software.amazon.awssdk.services.dynamodb.model

Class GetShardIteratorRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.dynamodb.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 of a GetShardIterator operation.

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()
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.
String	shardIteratorType()	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()

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

streamArn

public String streamArn()

The Amazon Resource Name (ARN) for the stream.

Returns:

The Amazon Resource Name (ARN) for the stream.

shardId

public String shardId()

The identifier of the shard. The iterator will be returned for this shard ID.

Returns:

The identifier of the shard. The iterator will be returned for this shard ID.

shardIteratorType

public 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.

Returns:

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.

See Also:

ShardIteratorType

sequenceNumber

public String sequenceNumber()

The sequence number of a stream record in the shard from which to start reading.

Returns:

The sequence number of a stream record in the shard from which to start reading.

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