public class GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input for GetShardIterator
.
NOOP
Constructor and Description |
---|
GetShardIteratorRequest() |
Modifier and Type | Method and Description |
---|---|
GetShardIteratorRequest |
clone() |
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.
|
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
public void setStreamName(String streamName)
The name of the Amazon Kinesis stream.
streamName
- The name of the Amazon Kinesis stream.public String getStreamName()
The name of the Amazon Kinesis stream.
public GetShardIteratorRequest withStreamName(String streamName)
The name of the Amazon Kinesis stream.
streamName
- The name of the Amazon Kinesis stream.public void setShardId(String shardId)
The shard ID of the Amazon Kinesis shard to get the iterator for.
shardId
- The shard ID of the Amazon Kinesis shard to get the iterator for.public String getShardId()
The shard ID of the Amazon Kinesis shard to get the iterator for.
public GetShardIteratorRequest withShardId(String shardId)
The shard ID of the Amazon Kinesis shard to get the iterator for.
shardId
- The shard ID of the Amazon Kinesis shard to get the iterator for.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:
StartingSequenceNumber
.StartingSequenceNumber
.Timestamp
.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:
StartingSequenceNumber
.StartingSequenceNumber
.Timestamp
.ShardIteratorType
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:
StartingSequenceNumber
.StartingSequenceNumber
.Timestamp
.The following are the valid Amazon Kinesis shard iterator types:
StartingSequenceNumber
.StartingSequenceNumber
.Timestamp
.
ShardIteratorType
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:
StartingSequenceNumber
.StartingSequenceNumber
.Timestamp
.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:
StartingSequenceNumber
.StartingSequenceNumber
.Timestamp
.ShardIteratorType
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:
StartingSequenceNumber
.StartingSequenceNumber
.Timestamp
.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:
StartingSequenceNumber
.StartingSequenceNumber
.Timestamp
.ShardIteratorType
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:
StartingSequenceNumber
.StartingSequenceNumber
.Timestamp
.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:
StartingSequenceNumber
.StartingSequenceNumber
.Timestamp
.ShardIteratorType
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.
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.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.
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.
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.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).
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).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).
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).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).
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).public String toString()
toString
in class Object
Object.toString()
public GetShardIteratorRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2016. All rights reserved.