class Amazonite::Kinesis::GetRecordsInput

Overview

Represents the input for GetRecords.

Included Modules

Defined in:

kinesis/get_records_input.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(shard_iterator : String, limit : Int32 | Nil = nil, stream_arn : String | Nil = nil, stream_id : String | Nil = nil, dry_run : Bool | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable 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 limit : Int32 | Nil #

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. The default value is 10,000.


[View source]
def limit=(limit : Int32 | Nil) #

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException. The default value is 10,000.


[View source]
def shard_iterator : String #

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.


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

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.


[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 validate! : Nil #

[View source]