class
Amazonite::Kinesis::GetRecordsOutput
- Amazonite::Kinesis::GetRecordsOutput
- Reference
- Object
Overview
Represents the output for GetRecords.
Included Modules
- JSON::Serializable
Defined in:
kinesis/get_records_output.crConstructors
- .new(records : Array(Record), next_shard_iterator : String | Nil = nil, millis_behind_latest : Int64 | Nil = nil, child_shards : Array(ChildShard) | Nil = nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#child_shards : Array(ChildShard) | Nil
The list of the current shard's child shards, returned in the
GetRecordsAPI's response only when the end of the current shard is reached. -
#child_shards=(child_shards : Array(ChildShard) | Nil)
The list of the current shard's child shards, returned in the
GetRecordsAPI's response only when the end of the current shard is reached. -
#hash(hasher)
See
Object#hash(hasher) -
#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.
-
#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.
-
#next_shard_iterator : String | Nil
The next position in the shard from which to start sequentially reading data records.
-
#next_shard_iterator=(next_shard_iterator : String | Nil)
The next position in the shard from which to start sequentially reading data records.
-
#records : Array(Record)
The data records retrieved from the shard.
-
#records=(records : Array(Record))
The data records retrieved from the shard.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
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.
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.
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.
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.