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

Class GetShardIteratorRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.dynamodb.model.DynamoDbStreamsRequest

software.amazon.awssdk.services.dynamodb.model.GetShardIteratorRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetShardIteratorRequest
extends DynamoDbStreamsRequest
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

Method Summary

Modifier and Type	Method	Description
static GetShardIteratorRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
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	shardIteratorTypeAsString()	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()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

streamArn

public final String streamArn()

The Amazon Resource Name (ARN) for the stream.

Returns:

The Amazon Resource Name (ARN) for the stream.

shardId

public final 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 final 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 shardIteratorTypeAsString().

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

shardIteratorTypeAsString

public final String shardIteratorTypeAsString()

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 shardIteratorTypeAsString().

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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>

Specified by:

toBuilder in class DynamoDbStreamsRequest

builder

public static GetShardIteratorRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo