class Amazonite::Kinesis::GetShardIteratorInput

Overview

Represents the input for GetShardIterator.

Included Modules

Defined in:

kinesis/get_shard_iterator_input.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(shard_id : String, shard_iterator_type : ShardIteratorType, stream_name : String | Nil = nil, starting_sequence_number : String | Nil = nil, timestamp : Time | Nil = nil, stream_arn : String | Nil = nil, stream_id : String | Nil = nil, dry_run : Bool | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def dry_run : Bool | Nil #

Checks if your request will succeed. DryRun is an optional parameter.


[View source]
def dry_run=(dry_run : Bool | Nil) #

Checks if your request will succeed. DryRun is an optional parameter.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def shard_id : String #

The shard ID of the Kinesis Data Streams shard to get the iterator for.


[View source]
def shard_id=(shard_id : String) #

The shard ID of the Kinesis Data Streams shard to get the iterator for.


[View source]
def shard_iterator_type : 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.


[View source]
def shard_iterator_type=(shard_iterator_type : 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.


[View source]
def starting_sequence_number : String | Nil #

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.


[View source]
def starting_sequence_number=(starting_sequence_number : String | Nil) #

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.


[View source]
def stream_arn : String | Nil #

The ARN of the stream.


[View source]
def stream_arn=(stream_arn : String | Nil) #

The ARN of the stream.


[View source]
def stream_id : String | Nil #

Not Implemented. Reserved for future use.


[View source]
def stream_id=(stream_id : String | Nil) #

Not Implemented. Reserved for future use.


[View source]
def stream_name : String | Nil #

The name of the Amazon Kinesis data stream.


[View source]
def stream_name=(stream_name : String | Nil) #

The name of the Amazon Kinesis data stream.


[View source]
def timestamp : Time | Nil #

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


[View source]
def timestamp=(timestamp : Time | Nil) #

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


[View source]
def validate! : Nil #

[View source]