com.amazonaws.services.dynamodbv2.model

Class GetShardIteratorRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.dynamodbv2.model.GetShardIteratorRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetShardIteratorRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of a GetShardIterator operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetShardIteratorRequest()

Method Summary

Modifier and Type	Method and Description
GetShardIteratorRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getSequenceNumber() The sequence number of a stream record in the shard from which to start reading.
String	getShardId() The identifier of the shard.
String	getShardIteratorType() Determines how the shard iterator is used to start reading stream records from the shard:
String	getStreamArn() The Amazon Resource Name (ARN) for the stream.
int	hashCode()
void	setSequenceNumber(String sequenceNumber) The sequence number of a stream record in the shard from which to start reading.
void	setShardId(String shardId) The identifier of the shard.
void	setShardIteratorType(ShardIteratorType shardIteratorType) Determines how the shard iterator is used to start reading stream records from the shard:
void	setShardIteratorType(String shardIteratorType) Determines how the shard iterator is used to start reading stream records from the shard:
void	setStreamArn(String streamArn) The Amazon Resource Name (ARN) for the stream.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetShardIteratorRequest	withSequenceNumber(String sequenceNumber) The sequence number of a stream record in the shard from which to start reading.
GetShardIteratorRequest	withShardId(String shardId) The identifier of the shard.
GetShardIteratorRequest	withShardIteratorType(ShardIteratorType shardIteratorType) Determines how the shard iterator is used to start reading stream records from the shard:
GetShardIteratorRequest	withShardIteratorType(String shardIteratorType) Determines how the shard iterator is used to start reading stream records from the shard:
GetShardIteratorRequest	withStreamArn(String streamArn) The Amazon Resource Name (ARN) for the stream.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetShardIteratorRequest

public GetShardIteratorRequest()

Method Detail

setStreamArn

public void setStreamArn(String streamArn)

The Amazon Resource Name (ARN) for the stream.

Parameters:

streamArn - The Amazon Resource Name (ARN) for the stream.

getStreamArn

public String getStreamArn()

The Amazon Resource Name (ARN) for the stream.

Returns:

The Amazon Resource Name (ARN) for the stream.

withStreamArn

public GetShardIteratorRequest withStreamArn(String streamArn)

The Amazon Resource Name (ARN) for the stream.

Parameters:

streamArn - The Amazon Resource Name (ARN) for the stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

setShardId

public void setShardId(String shardId)

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

Parameters:

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

getShardId

public String getShardId()

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.

withShardId

public GetShardIteratorRequest withShardId(String shardId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setShardIteratorType

public void setShardIteratorType(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.

Parameters:

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.

See Also:

ShardIteratorType

getShardIteratorType

public String getShardIteratorType()

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

withShardIteratorType

public GetShardIteratorRequest withShardIteratorType(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

ShardIteratorType

setShardIteratorType

public void setShardIteratorType(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.

Parameters:

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.

See Also:

ShardIteratorType

withShardIteratorType

public GetShardIteratorRequest withShardIteratorType(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

ShardIteratorType

setSequenceNumber

public void setSequenceNumber(String sequenceNumber)

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

Parameters:

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

getSequenceNumber

public String getSequenceNumber()

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.

withSequenceNumber

public GetShardIteratorRequest withSequenceNumber(String sequenceNumber)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetShardIteratorRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()