Class: Aws::Kinesis::Types::PutRecordInput

Inherits:

Struct

• Object
• Struct
• Aws::Kinesis::Types::PutRecordInput

Defined in:

gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

Represents the input for PutRecord.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data ⇒ String

  The data blob to put into the record, which is base64-encoded when the blob is serialized.

• #explicit_hash_key ⇒ String

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

• #partition_key ⇒ String

  Determines which shard in the stream the data record is assigned to.

• #sequence_number_for_ordering ⇒ String

  Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key.

• #stream_arn ⇒ String

  The ARN of the stream.

• #stream_name ⇒ String

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

Instance Attribute Details

#data ⇒ String

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 (1 MiB).

Returns:

• (String)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1471

class PutRecordInput < Struct.new(
  :stream_name,
  :data,
  :partition_key,
  :explicit_hash_key,
  :sequence_number_for_ordering,
  :stream_arn)
  SENSITIVE = []
  include Aws::Structure
end

#explicit_hash_key ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1471

class PutRecordInput < Struct.new(
  :stream_name,
  :data,
  :partition_key,
  :explicit_hash_key,
  :sequence_number_for_ordering,
  :stream_arn)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1471

class PutRecordInput < Struct.new(
  :stream_name,
  :data,
  :partition_key,
  :explicit_hash_key,
  :sequence_number_for_ordering,
  :stream_arn)
  SENSITIVE = []
  include Aws::Structure
end

#sequence_number_for_ordering ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1471

class PutRecordInput < Struct.new(
  :stream_name,
  :data,
  :partition_key,
  :explicit_hash_key,
  :sequence_number_for_ordering,
  :stream_arn)
  SENSITIVE = []
  include Aws::Structure
end

#stream_arn ⇒ String

The ARN of the stream.

Returns:

• (String)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1471

class PutRecordInput < Struct.new(
  :stream_name,
  :data,
  :partition_key,
  :explicit_hash_key,
  :sequence_number_for_ordering,
  :stream_arn)
  SENSITIVE = []
  include Aws::Structure
end

#stream_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 1471

class PutRecordInput < Struct.new(
  :stream_name,
  :data,
  :partition_key,
  :explicit_hash_key,
  :sequence_number_for_ordering,
  :stream_arn)
  SENSITIVE = []
  include Aws::Structure
end