Package com.amazonaws.services.kinesis.model

Class GetShardIteratorRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.GetShardIteratorRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetShardIteratorRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for GetShardIterator.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
GetShardIteratorRequest()

Method Summary

Modifier and Type	Method	Description
GetShardIteratorRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getShardId()	The shard ID of the Amazon Kinesis shard to get the iterator for.
String	getShardIteratorType()	Determines how the shard iterator is used to start reading data records from the shard.
String	getStartingSequenceNumber()	The sequence number of the data record in the shard from which to start reading.
String	getStreamName()	The name of the Amazon Kinesis stream.
Date	getTimestamp()	The timestamp of the data record from which to start reading.
int	hashCode()
void	setShardId(String shardId)	The shard ID of the Amazon Kinesis shard to get the iterator for.
void	setShardIteratorType(ShardIteratorType shardIteratorType)	Determines how the shard iterator is used to start reading data records from the shard.
void	setShardIteratorType(String shardIteratorType)	Determines how the shard iterator is used to start reading data records from the shard.
void	setStartingSequenceNumber(String startingSequenceNumber)	The sequence number of the data record in the shard from which to start reading.
void	setStreamName(String streamName)	The name of the Amazon Kinesis stream.
void	setTimestamp(Date timestamp)	The timestamp of the data record from which to start reading.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
GetShardIteratorRequest	withShardId(String shardId)	The shard ID of the Amazon Kinesis shard to get the iterator for.
GetShardIteratorRequest	withShardIteratorType(ShardIteratorType shardIteratorType)	Determines how the shard iterator is used to start reading data records from the shard.
GetShardIteratorRequest	withShardIteratorType(String shardIteratorType)	Determines how the shard iterator is used to start reading data records from the shard.
GetShardIteratorRequest	withStartingSequenceNumber(String startingSequenceNumber)	The sequence number of the data record in the shard from which to start reading.
GetShardIteratorRequest	withStreamName(String streamName)	The name of the Amazon Kinesis stream.
GetShardIteratorRequest	withTimestamp(Date timestamp)	The timestamp of the data record from which to start reading.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, 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

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

Constructor Detail

GetShardIteratorRequest

public GetShardIteratorRequest()

Method Detail

setStreamName

public void setStreamName(String streamName)

The name of the Amazon Kinesis stream.

Parameters:

streamName - The name of the Amazon Kinesis stream.

getStreamName

public String getStreamName()

The name of the Amazon Kinesis stream.

Returns:

The name of the Amazon Kinesis stream.

withStreamName

public GetShardIteratorRequest withStreamName(String streamName)

The name of the Amazon Kinesis stream.

Parameters:

streamName - The name of the Amazon Kinesis stream.

Returns:

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

setShardId

public void setShardId(String shardId)

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

Parameters:

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

getShardId

public String getShardId()

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.

withShardId

public GetShardIteratorRequest withShardId(String shardId)

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

Parameters:

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

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

Parameters:

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.

See Also:

ShardIteratorType

getShardIteratorType

public String getShardIteratorType()

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

withShardIteratorType

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

Parameters:

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:

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

Parameters:

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.

See Also:

ShardIteratorType

withShardIteratorType

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

Parameters:

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:

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

See Also:

ShardIteratorType

setStartingSequenceNumber

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

Parameters:

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.

getStartingSequenceNumber

public String getStartingSequenceNumber()

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.

withStartingSequenceNumber

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

Parameters:

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:

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

setTimestamp

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

Parameters:

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

getTimestamp

public Date getTimestamp()

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

withTimestamp

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

Parameters:

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:

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 request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()