AWS SDK for C++  1.9.132
AWS SDK for C++
Public Member Functions | List of all members
Aws::Kinesis::Model::PutRecordsRequestEntry Class Reference

#include <PutRecordsRequestEntry.h>

Public Member Functions

 PutRecordsRequestEntry ()
 
 PutRecordsRequestEntry (Aws::Utils::Json::JsonView jsonValue)
 
PutRecordsRequestEntryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Utils::ByteBufferGetData () const
 
bool DataHasBeenSet () const
 
void SetData (const Aws::Utils::ByteBuffer &value)
 
void SetData (Aws::Utils::ByteBuffer &&value)
 
PutRecordsRequestEntryWithData (const Aws::Utils::ByteBuffer &value)
 
PutRecordsRequestEntryWithData (Aws::Utils::ByteBuffer &&value)
 
const Aws::StringGetExplicitHashKey () const
 
bool ExplicitHashKeyHasBeenSet () const
 
void SetExplicitHashKey (const Aws::String &value)
 
void SetExplicitHashKey (Aws::String &&value)
 
void SetExplicitHashKey (const char *value)
 
PutRecordsRequestEntryWithExplicitHashKey (const Aws::String &value)
 
PutRecordsRequestEntryWithExplicitHashKey (Aws::String &&value)
 
PutRecordsRequestEntryWithExplicitHashKey (const char *value)
 
const Aws::StringGetPartitionKey () const
 
bool PartitionKeyHasBeenSet () const
 
void SetPartitionKey (const Aws::String &value)
 
void SetPartitionKey (Aws::String &&value)
 
void SetPartitionKey (const char *value)
 
PutRecordsRequestEntryWithPartitionKey (const Aws::String &value)
 
PutRecordsRequestEntryWithPartitionKey (Aws::String &&value)
 
PutRecordsRequestEntryWithPartitionKey (const char *value)
 

Detailed Description

Represents the output for PutRecords.

See Also:


AWS API Reference

Definition at line 33 of file PutRecordsRequestEntry.h.

Constructor & Destructor Documentation

◆ PutRecordsRequestEntry() [1/2]

Aws::Kinesis::Model::PutRecordsRequestEntry::PutRecordsRequestEntry ( )

◆ PutRecordsRequestEntry() [2/2]

Aws::Kinesis::Model::PutRecordsRequestEntry::PutRecordsRequestEntry ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DataHasBeenSet()

bool Aws::Kinesis::Model::PutRecordsRequestEntry::DataHasBeenSet ( ) const
inline

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

Definition at line 56 of file PutRecordsRequestEntry.h.

◆ ExplicitHashKeyHasBeenSet()

bool Aws::Kinesis::Model::PutRecordsRequestEntry::ExplicitHashKeyHasBeenSet ( ) const
inline

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

Definition at line 101 of file PutRecordsRequestEntry.h.

◆ GetData()

const Aws::Utils::ByteBuffer& Aws::Kinesis::Model::PutRecordsRequestEntry::GetData ( ) const
inline

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

Definition at line 48 of file PutRecordsRequestEntry.h.

◆ GetExplicitHashKey()

const Aws::String& Aws::Kinesis::Model::PutRecordsRequestEntry::GetExplicitHashKey ( ) const
inline

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

Definition at line 95 of file PutRecordsRequestEntry.h.

◆ GetPartitionKey()

const Aws::String& Aws::Kinesis::Model::PutRecordsRequestEntry::GetPartitionKey ( ) const
inline

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.

Definition at line 150 of file PutRecordsRequestEntry.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Kinesis::Model::PutRecordsRequestEntry::Jsonize ( ) const

◆ operator=()

PutRecordsRequestEntry& Aws::Kinesis::Model::PutRecordsRequestEntry::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PartitionKeyHasBeenSet()

bool Aws::Kinesis::Model::PutRecordsRequestEntry::PartitionKeyHasBeenSet ( ) const
inline

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.

Definition at line 162 of file PutRecordsRequestEntry.h.

◆ SetData() [1/2]

void Aws::Kinesis::Model::PutRecordsRequestEntry::SetData ( Aws::Utils::ByteBuffer &&  value)
inline

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

Definition at line 72 of file PutRecordsRequestEntry.h.

◆ SetData() [2/2]

void Aws::Kinesis::Model::PutRecordsRequestEntry::SetData ( const Aws::Utils::ByteBuffer value)
inline

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

Definition at line 64 of file PutRecordsRequestEntry.h.

◆ SetExplicitHashKey() [1/3]

void Aws::Kinesis::Model::PutRecordsRequestEntry::SetExplicitHashKey ( Aws::String &&  value)
inline

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

Definition at line 113 of file PutRecordsRequestEntry.h.

◆ SetExplicitHashKey() [2/3]

void Aws::Kinesis::Model::PutRecordsRequestEntry::SetExplicitHashKey ( const Aws::String value)
inline

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

Definition at line 107 of file PutRecordsRequestEntry.h.

◆ SetExplicitHashKey() [3/3]

void Aws::Kinesis::Model::PutRecordsRequestEntry::SetExplicitHashKey ( const char *  value)
inline

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

Definition at line 119 of file PutRecordsRequestEntry.h.

◆ SetPartitionKey() [1/3]

void Aws::Kinesis::Model::PutRecordsRequestEntry::SetPartitionKey ( Aws::String &&  value)
inline

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.

Definition at line 186 of file PutRecordsRequestEntry.h.

◆ SetPartitionKey() [2/3]

void Aws::Kinesis::Model::PutRecordsRequestEntry::SetPartitionKey ( const Aws::String value)
inline

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.

Definition at line 174 of file PutRecordsRequestEntry.h.

◆ SetPartitionKey() [3/3]

void Aws::Kinesis::Model::PutRecordsRequestEntry::SetPartitionKey ( const char *  value)
inline

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.

Definition at line 198 of file PutRecordsRequestEntry.h.

◆ WithData() [1/2]

PutRecordsRequestEntry& Aws::Kinesis::Model::PutRecordsRequestEntry::WithData ( Aws::Utils::ByteBuffer &&  value)
inline

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

Definition at line 88 of file PutRecordsRequestEntry.h.

◆ WithData() [2/2]

PutRecordsRequestEntry& Aws::Kinesis::Model::PutRecordsRequestEntry::WithData ( const Aws::Utils::ByteBuffer value)
inline

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

Definition at line 80 of file PutRecordsRequestEntry.h.

◆ WithExplicitHashKey() [1/3]

PutRecordsRequestEntry& Aws::Kinesis::Model::PutRecordsRequestEntry::WithExplicitHashKey ( Aws::String &&  value)
inline

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

Definition at line 131 of file PutRecordsRequestEntry.h.

◆ WithExplicitHashKey() [2/3]

PutRecordsRequestEntry& Aws::Kinesis::Model::PutRecordsRequestEntry::WithExplicitHashKey ( const Aws::String value)
inline

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

Definition at line 125 of file PutRecordsRequestEntry.h.

◆ WithExplicitHashKey() [3/3]

PutRecordsRequestEntry& Aws::Kinesis::Model::PutRecordsRequestEntry::WithExplicitHashKey ( const char *  value)
inline

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

Definition at line 137 of file PutRecordsRequestEntry.h.

◆ WithPartitionKey() [1/3]

PutRecordsRequestEntry& Aws::Kinesis::Model::PutRecordsRequestEntry::WithPartitionKey ( Aws::String &&  value)
inline

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.

Definition at line 222 of file PutRecordsRequestEntry.h.

◆ WithPartitionKey() [2/3]

PutRecordsRequestEntry& Aws::Kinesis::Model::PutRecordsRequestEntry::WithPartitionKey ( const Aws::String value)
inline

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.

Definition at line 210 of file PutRecordsRequestEntry.h.

◆ WithPartitionKey() [3/3]

PutRecordsRequestEntry& Aws::Kinesis::Model::PutRecordsRequestEntry::WithPartitionKey ( const char *  value)
inline

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.

Definition at line 234 of file PutRecordsRequestEntry.h.


The documentation for this class was generated from the following file: