GetShardIteratorRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kinesis.model.GetShardIteratorRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class GetShardIteratorRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.

A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.

You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.

When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.

If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide.

If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards.

GetShardIterator has a limit of five transactions per second per account per open shard.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetShardIteratorRequest()

Constructors
Constructor and Description
`GetShardIteratorRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getShardId()` The shard ID of the Kinesis Data Streams shard to get the iterator for.
`java.lang.String`	`getShardIteratorType()` Determines how the shard iterator is used to start reading data records from the shard.
`java.lang.String`	`getStartingSequenceNumber()` The sequence number of the data record in the shard from which to start reading.
`java.lang.String`	`getStreamName()` The name of the Amazon Kinesis data stream.
`java.util.Date`	`getTimestamp()` The time stamp of the data record from which to start reading.
`int`	`hashCode()`
`void`	`setShardId(java.lang.String shardId)` The shard ID of the Kinesis Data Streams 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(java.lang.String shardIteratorType)` Determines how the shard iterator is used to start reading data records from the shard.
`void`	`setStartingSequenceNumber(java.lang.String startingSequenceNumber)` The sequence number of the data record in the shard from which to start reading.
`void`	`setStreamName(java.lang.String streamName)` The name of the Amazon Kinesis data stream.
`void`	`setTimestamp(java.util.Date timestamp)` The time stamp of the data record from which to start reading.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetShardIteratorRequest`	`withShardId(java.lang.String shardId)` The shard ID of the Kinesis Data Streams 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(java.lang.String shardIteratorType)` Determines how the shard iterator is used to start reading data records from the shard.
`GetShardIteratorRequest`	`withStartingSequenceNumber(java.lang.String startingSequenceNumber)` The sequence number of the data record in the shard from which to start reading.
`GetShardIteratorRequest`	`withStreamName(java.lang.String streamName)` The name of the Amazon Kinesis data stream.
`GetShardIteratorRequest`	`withTimestamp(java.util.Date timestamp)` The time stamp of the data record from which to start reading.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetShardIteratorRequest
```
public GetShardIteratorRequest()
```
- Method Detail
  - getStreamName
```
public java.lang.String getStreamName()
```
    The name of the Amazon Kinesis data stream.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The name of the Amazon Kinesis data stream.
  - setStreamName
```
public void setStreamName(java.lang.String streamName)
```
    The name of the Amazon Kinesis data stream.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    streamName -
    The name of the Amazon Kinesis data stream.
  - withStreamName
```
public GetShardIteratorRequest withStreamName(java.lang.String streamName)
```
    The name of the Amazon Kinesis data stream.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    streamName -
    The name of the Amazon Kinesis data stream.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getShardId
```
public java.lang.String getShardId()
```
    The shard ID of the Kinesis Data Streams shard to get the iterator for.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The shard ID of the Kinesis Data Streams shard to get the iterator for.
  - setShardId
```
public void setShardId(java.lang.String shardId)
```
    The shard ID of the Kinesis Data Streams shard to get the iterator for.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    shardId -
    The shard ID of the Kinesis Data Streams shard to get the iterator for.
  - withShardId
```
public GetShardIteratorRequest withShardId(java.lang.String shardId)
```
    The shard ID of the Kinesis Data Streams shard to get the iterator for.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    shardId -
    The shard ID of the Kinesis Data Streams shard to get the iterator for.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getShardIteratorType
```
public java.lang.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 time stamp, 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.
    Constraints:
    Allowed Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
    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 time stamp, 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
  - setShardIteratorType
```
public void setShardIteratorType(java.lang.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 time stamp, 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.
    Constraints:
    Allowed Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
    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 time stamp, 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(java.lang.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 time stamp, 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 a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
    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 time stamp, 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:
    
    A reference to this updated 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 time stamp, 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.
    Constraints:
    Allowed Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
    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 time stamp, 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 time stamp, 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 a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
    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 time stamp, 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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ShardIteratorType
  - getStartingSequenceNumber
```
public java.lang.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.
    
    Constraints:
    Pattern: 0|([1-9]\d{0,128})
    
    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.
  - setStartingSequenceNumber
```
public void setStartingSequenceNumber(java.lang.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.
    
    Constraints:
    Pattern: 0|([1-9]\d{0,128})
    
    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.
  - withStartingSequenceNumber
```
public GetShardIteratorRequest withStartingSequenceNumber(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: 0|([1-9]\d{0,128})
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getTimestamp
```
public java.util.Date getTimestamp()
```
    The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp 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 time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
    
    Returns:
    
    The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp 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 time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
  - setTimestamp
```
public void setTimestamp(java.util.Date timestamp)
```
    The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp 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 time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
    
    Parameters:
    
    timestamp -
    The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp 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 time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
  - withTimestamp
```
public GetShardIteratorRequest withTimestamp(java.util.Date timestamp)
```
    The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp 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 time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    timestamp -
    The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp 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 time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class GetShardIteratorRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetShardIteratorRequest

Method Detail

getStreamName

setStreamName

withStreamName

getShardId

setShardId

withShardId

getShardIteratorType

setShardIteratorType

withShardIteratorType

setShardIteratorType

withShardIteratorType

getStartingSequenceNumber

setStartingSequenceNumber

withStartingSequenceNumber

getTimestamp

setTimestamp

withTimestamp

toString

hashCode

equals