class
Amazonite::Kinesis::StartingPosition
- Amazonite::Kinesis::StartingPosition
- Reference
- Object
Overview
The starting position in the data stream from which to start streaming.
Included Modules
- JSON::Serializable
Defined in:
kinesis/starting_position.crConstructors
- .new(pull : JSON::PullParser)
- .new(type : ShardIteratorType, sequence_number : String | Nil = nil, timestamp : Time | Nil = nil)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#hash(hasher)
See
Object#hash(hasher) -
#sequence_number : String | Nil
The sequence number of the data record in the shard from which to start streaming.
-
#sequence_number=(sequence_number : String | Nil)
The sequence number of the data record in the shard from which to start streaming.
-
#timestamp : Time | Nil
The time stamp of the data record from which to start reading.
-
#timestamp=(timestamp : Time | Nil)
The time stamp of the data record from which to start reading.
-
#type : ShardIteratorType
You can set the starting position to one of the following values:
-
#type=(type : ShardIteratorType)
You can set the starting position to one of the following values:
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
The sequence number of the data record in the shard from which to start streaming. To specify a
sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.
The sequence number of the data record in the shard from which to start streaming. To specify a
sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.
The time stamp of the data record from which to start reading. To specify a time stamp, set
StartingPosition to 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, records will be streamed from the next (later) record. If
the time stamp is older than the current trim horizon, records will be streamed from the oldest
untrimmed data record (TRIM_HORIZON).
The time stamp of the data record from which to start reading. To specify a time stamp, set
StartingPosition to 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, records will be streamed from the next (later) record. If
the time stamp is older than the current trim horizon, records will be streamed from the oldest
untrimmed data record (TRIM_HORIZON).
You can set the starting position to one of the following values:
AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence number specified
in the SequenceNumber field.
AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number
specified in the SequenceNumber field.
AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the
Timestamp field.
TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, which is the oldest
data record in the shard.
LATEST: Start streaming just after the most recent record in the shard, so that you always
read the most recent data in the shard.
You can set the starting position to one of the following values:
AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence number specified
in the SequenceNumber field.
AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number
specified in the SequenceNumber field.
AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the
Timestamp field.
TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, which is the oldest
data record in the shard.
LATEST: Start streaming just after the most recent record in the shard, so that you always
read the most recent data in the shard.