Struct aws_sdk_kinesis::input::PutRecordInput

#[non_exhaustive]
pub struct PutRecordInput {
    pub stream_name: Option<String>,
    pub data: Option<Blob>,
    pub partition_key: Option<String>,
    pub explicit_hash_key: Option<String>,
    pub sequence_number_for_ordering: Option<String>,
}

Represents the input for PutRecord.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stream_name: Option<String>

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

data: Option<Blob>

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

partition_key: Option<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.

explicit_hash_key: Option<String>

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

sequence_number_for_ordering: Option<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.

Implementations

impl PutRecordInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<PutRecord, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<PutRecord>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture PutRecordInput

impl PutRecordInput

pub fn stream_name(&self) -> Option<&str>

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

pub fn data(&self) -> Option<&Blob>

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

pub fn partition_key(&self) -> Option<&str>

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.

pub fn explicit_hash_key(&self) -> Option<&str>

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

pub fn sequence_number_for_ordering(&self) -> Option<&str>

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.

Trait Implementations

impl Clone for PutRecordInput

fn clone(&self) -> PutRecordInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutRecordInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<PutRecordInput> for PutRecordInput

fn eq(&self, other: &PutRecordInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PutRecordInput) -> bool

This method tests for !=.

impl StructuralPartialEq for PutRecordInput