class Amazonite::Kinesis::PutRecordInput

Overview

Represents the input for PutRecord.

Included Modules

Defined in:

kinesis/put_record_input.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(data : Bytes, partition_key : String, stream_name : String | Nil = nil, explicit_hash_key : String | Nil = nil, sequence_number_for_ordering : String | 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 data : Bytes #

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (10 MiB).


[View source]
def data=(data : Bytes) #

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (10 MiB).


[View source]
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 explicit_hash_key : String | Nil #

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.


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

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.


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

See Object#hash(hasher)


def partition_key : String #

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.


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

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.


[View source]
def sequence_number_for_ordering : String | Nil #

Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.


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

Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.


[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 stream to put the data record into.


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

The name of the stream to put the data record into.


[View source]
def validate! : Nil #

[View source]