class Amazonite::Kinesis::GetRecordsOutput

Overview

Represents the output for GetRecords.

Included Modules

Defined in:

kinesis/get_records_output.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(records : Array(Record), next_shard_iterator : String | Nil = nil, millis_behind_latest : Int64 | Nil = nil, child_shards : Array(ChildShard) | 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 child_shards : Array(ChildShard) | Nil #

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.


[View source]
def child_shards=(child_shards : Array(ChildShard) | Nil) #

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.


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

See Object#hash(hasher)


def millis_behind_latest : Int64 | Nil #

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.


[View source]
def millis_behind_latest=(millis_behind_latest : Int64 | Nil) #

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.


[View source]
def next_shard_iterator : String | Nil #

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.


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

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.


[View source]
def records : Array(Record) #

The data records retrieved from the shard.


[View source]
def records=(records : Array(Record)) #

The data records retrieved from the shard.


[View source]
def validate! : Nil #

[View source]