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

#include <PutRecordRequest.h>

+ Inheritance diagram for Aws::Kinesis::Model::PutRecordRequest:

Public Member Functions

 PutRecordRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetStreamName () const
 
bool StreamNameHasBeenSet () const
 
void SetStreamName (const Aws::String &value)
 
void SetStreamName (Aws::String &&value)
 
void SetStreamName (const char *value)
 
PutRecordRequestWithStreamName (const Aws::String &value)
 
PutRecordRequestWithStreamName (Aws::String &&value)
 
PutRecordRequestWithStreamName (const char *value)
 
const Aws::Utils::ByteBufferGetData () const
 
bool DataHasBeenSet () const
 
void SetData (const Aws::Utils::ByteBuffer &value)
 
void SetData (Aws::Utils::ByteBuffer &&value)
 
PutRecordRequestWithData (const Aws::Utils::ByteBuffer &value)
 
PutRecordRequestWithData (Aws::Utils::ByteBuffer &&value)
 
const Aws::StringGetPartitionKey () const
 
bool PartitionKeyHasBeenSet () const
 
void SetPartitionKey (const Aws::String &value)
 
void SetPartitionKey (Aws::String &&value)
 
void SetPartitionKey (const char *value)
 
PutRecordRequestWithPartitionKey (const Aws::String &value)
 
PutRecordRequestWithPartitionKey (Aws::String &&value)
 
PutRecordRequestWithPartitionKey (const char *value)
 
const Aws::StringGetExplicitHashKey () const
 
bool ExplicitHashKeyHasBeenSet () const
 
void SetExplicitHashKey (const Aws::String &value)
 
void SetExplicitHashKey (Aws::String &&value)
 
void SetExplicitHashKey (const char *value)
 
PutRecordRequestWithExplicitHashKey (const Aws::String &value)
 
PutRecordRequestWithExplicitHashKey (Aws::String &&value)
 
PutRecordRequestWithExplicitHashKey (const char *value)
 
const Aws::StringGetSequenceNumberForOrdering () const
 
bool SequenceNumberForOrderingHasBeenSet () const
 
void SetSequenceNumberForOrdering (const Aws::String &value)
 
void SetSequenceNumberForOrdering (Aws::String &&value)
 
void SetSequenceNumberForOrdering (const char *value)
 
PutRecordRequestWithSequenceNumberForOrdering (const Aws::String &value)
 
PutRecordRequestWithSequenceNumberForOrdering (Aws::String &&value)
 
PutRecordRequestWithSequenceNumberForOrdering (const char *value)
 
- Public Member Functions inherited from Aws::Kinesis::KinesisRequest
virtual ~KinesisRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the input for PutRecord.

See Also:

AWS API Reference

Definition at line 26 of file PutRecordRequest.h.

Constructor & Destructor Documentation

◆ PutRecordRequest()

Aws::Kinesis::Model::PutRecordRequest::PutRecordRequest ( )

Member Function Documentation

◆ DataHasBeenSet()

bool Aws::Kinesis::Model::PutRecordRequest::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 MB).

Definition at line 97 of file PutRecordRequest.h.

◆ ExplicitHashKeyHasBeenSet()

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

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

Definition at line 239 of file PutRecordRequest.h.

◆ GetData()

const Aws::Utils::ByteBuffer& Aws::Kinesis::Model::PutRecordRequest::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 MB).

Definition at line 89 of file PutRecordRequest.h.

◆ GetExplicitHashKey()

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

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

Definition at line 233 of file PutRecordRequest.h.

◆ GetPartitionKey()

const Aws::String& Aws::Kinesis::Model::PutRecordRequest::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 142 of file PutRecordRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Kinesis::Model::PutRecordRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Kinesis::KinesisRequest.

◆ GetSequenceNumberForOrdering()

const Aws::String& Aws::Kinesis::Model::PutRecordRequest::GetSequenceNumberForOrdering ( ) const
inline

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.

Definition at line 286 of file PutRecordRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Kinesis::Model::PutRecordRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file PutRecordRequest.h.

◆ GetStreamName()

const Aws::String& Aws::Kinesis::Model::PutRecordRequest::GetStreamName ( ) const
inline

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

Definition at line 45 of file PutRecordRequest.h.

◆ PartitionKeyHasBeenSet()

bool Aws::Kinesis::Model::PutRecordRequest::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 154 of file PutRecordRequest.h.

◆ SequenceNumberForOrderingHasBeenSet()

bool Aws::Kinesis::Model::PutRecordRequest::SequenceNumberForOrderingHasBeenSet ( ) const
inline

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.

Definition at line 296 of file PutRecordRequest.h.

◆ SerializePayload()

Aws::String Aws::Kinesis::Model::PutRecordRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetData() [1/2]

void Aws::Kinesis::Model::PutRecordRequest::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 MB).

Definition at line 105 of file PutRecordRequest.h.

◆ SetData() [2/2]

void Aws::Kinesis::Model::PutRecordRequest::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 MB).

Definition at line 113 of file PutRecordRequest.h.

◆ SetExplicitHashKey() [1/3]

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

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

Definition at line 245 of file PutRecordRequest.h.

◆ SetExplicitHashKey() [2/3]

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

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

Definition at line 251 of file PutRecordRequest.h.

◆ SetExplicitHashKey() [3/3]

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

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

Definition at line 257 of file PutRecordRequest.h.

◆ SetPartitionKey() [1/3]

void Aws::Kinesis::Model::PutRecordRequest::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 166 of file PutRecordRequest.h.

◆ SetPartitionKey() [2/3]

void Aws::Kinesis::Model::PutRecordRequest::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 178 of file PutRecordRequest.h.

◆ SetPartitionKey() [3/3]

void Aws::Kinesis::Model::PutRecordRequest::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 190 of file PutRecordRequest.h.

◆ SetSequenceNumberForOrdering() [1/3]

void Aws::Kinesis::Model::PutRecordRequest::SetSequenceNumberForOrdering ( const Aws::String value)
inline

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.

Definition at line 306 of file PutRecordRequest.h.

◆ SetSequenceNumberForOrdering() [2/3]

void Aws::Kinesis::Model::PutRecordRequest::SetSequenceNumberForOrdering ( Aws::String &&  value)
inline

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.

Definition at line 316 of file PutRecordRequest.h.

◆ SetSequenceNumberForOrdering() [3/3]

void Aws::Kinesis::Model::PutRecordRequest::SetSequenceNumberForOrdering ( const char *  value)
inline

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.

Definition at line 326 of file PutRecordRequest.h.

◆ SetStreamName() [1/3]

void Aws::Kinesis::Model::PutRecordRequest::SetStreamName ( const Aws::String value)
inline

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

Definition at line 55 of file PutRecordRequest.h.

◆ SetStreamName() [2/3]

void Aws::Kinesis::Model::PutRecordRequest::SetStreamName ( Aws::String &&  value)
inline

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

Definition at line 60 of file PutRecordRequest.h.

◆ SetStreamName() [3/3]

void Aws::Kinesis::Model::PutRecordRequest::SetStreamName ( const char *  value)
inline

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

Definition at line 65 of file PutRecordRequest.h.

◆ StreamNameHasBeenSet()

bool Aws::Kinesis::Model::PutRecordRequest::StreamNameHasBeenSet ( ) const
inline

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

Definition at line 50 of file PutRecordRequest.h.

◆ WithData() [1/2]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::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 MB).

Definition at line 121 of file PutRecordRequest.h.

◆ WithData() [2/2]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::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 MB).

Definition at line 129 of file PutRecordRequest.h.

◆ WithExplicitHashKey() [1/3]

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

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

Definition at line 263 of file PutRecordRequest.h.

◆ WithExplicitHashKey() [2/3]

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

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

Definition at line 269 of file PutRecordRequest.h.

◆ WithExplicitHashKey() [3/3]

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

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

Definition at line 275 of file PutRecordRequest.h.

◆ WithPartitionKey() [1/3]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::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 202 of file PutRecordRequest.h.

◆ WithPartitionKey() [2/3]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::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 214 of file PutRecordRequest.h.

◆ WithPartitionKey() [3/3]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::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 226 of file PutRecordRequest.h.

◆ WithSequenceNumberForOrdering() [1/3]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::WithSequenceNumberForOrdering ( const Aws::String value)
inline

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.

Definition at line 336 of file PutRecordRequest.h.

◆ WithSequenceNumberForOrdering() [2/3]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::WithSequenceNumberForOrdering ( Aws::String &&  value)
inline

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.

Definition at line 346 of file PutRecordRequest.h.

◆ WithSequenceNumberForOrdering() [3/3]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::WithSequenceNumberForOrdering ( const char *  value)
inline

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.

Definition at line 356 of file PutRecordRequest.h.

◆ WithStreamName() [1/3]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::WithStreamName ( const Aws::String value)
inline

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

Definition at line 70 of file PutRecordRequest.h.

◆ WithStreamName() [2/3]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::WithStreamName ( Aws::String &&  value)
inline

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

Definition at line 75 of file PutRecordRequest.h.

◆ WithStreamName() [3/3]

PutRecordRequest& Aws::Kinesis::Model::PutRecordRequest::WithStreamName ( const char *  value)
inline

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

Definition at line 80 of file PutRecordRequest.h.


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