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

#include <PutRecordsResultEntry.h>

Public Member Functions

 PutRecordsResultEntry ()
 
 PutRecordsResultEntry (Aws::Utils::Json::JsonView jsonValue)
 
PutRecordsResultEntryoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetSequenceNumber () const
 
bool SequenceNumberHasBeenSet () const
 
void SetSequenceNumber (const Aws::String &value)
 
void SetSequenceNumber (Aws::String &&value)
 
void SetSequenceNumber (const char *value)
 
PutRecordsResultEntryWithSequenceNumber (const Aws::String &value)
 
PutRecordsResultEntryWithSequenceNumber (Aws::String &&value)
 
PutRecordsResultEntryWithSequenceNumber (const char *value)
 
const Aws::StringGetShardId () const
 
bool ShardIdHasBeenSet () const
 
void SetShardId (const Aws::String &value)
 
void SetShardId (Aws::String &&value)
 
void SetShardId (const char *value)
 
PutRecordsResultEntryWithShardId (const Aws::String &value)
 
PutRecordsResultEntryWithShardId (Aws::String &&value)
 
PutRecordsResultEntryWithShardId (const char *value)
 
const Aws::StringGetErrorCode () const
 
bool ErrorCodeHasBeenSet () const
 
void SetErrorCode (const Aws::String &value)
 
void SetErrorCode (Aws::String &&value)
 
void SetErrorCode (const char *value)
 
PutRecordsResultEntryWithErrorCode (const Aws::String &value)
 
PutRecordsResultEntryWithErrorCode (Aws::String &&value)
 
PutRecordsResultEntryWithErrorCode (const char *value)
 
const Aws::StringGetErrorMessage () const
 
bool ErrorMessageHasBeenSet () const
 
void SetErrorMessage (const Aws::String &value)
 
void SetErrorMessage (Aws::String &&value)
 
void SetErrorMessage (const char *value)
 
PutRecordsResultEntryWithErrorMessage (const Aws::String &value)
 
PutRecordsResultEntryWithErrorMessage (Aws::String &&value)
 
PutRecordsResultEntryWithErrorMessage (const char *value)
 

Detailed Description

Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

See Also:

AWS API Reference

Definition at line 35 of file PutRecordsResultEntry.h.

Constructor & Destructor Documentation

◆ PutRecordsResultEntry() [1/2]

Aws::Kinesis::Model::PutRecordsResultEntry::PutRecordsResultEntry ( )

◆ PutRecordsResultEntry() [2/2]

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

Member Function Documentation

◆ ErrorCodeHasBeenSet()

bool Aws::Kinesis::Model::PutRecordsResultEntry::ErrorCodeHasBeenSet ( ) const
inline

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

Definition at line 138 of file PutRecordsResultEntry.h.

◆ ErrorMessageHasBeenSet()

bool Aws::Kinesis::Model::PutRecordsResultEntry::ErrorMessageHasBeenSet ( ) const
inline

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

Definition at line 199 of file PutRecordsResultEntry.h.

◆ GetErrorCode()

const Aws::String& Aws::Kinesis::Model::PutRecordsResultEntry::GetErrorCode ( ) const
inline

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

Definition at line 131 of file PutRecordsResultEntry.h.

◆ GetErrorMessage()

const Aws::String& Aws::Kinesis::Model::PutRecordsResultEntry::GetErrorMessage ( ) const
inline

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

Definition at line 190 of file PutRecordsResultEntry.h.

◆ GetSequenceNumber()

const Aws::String& Aws::Kinesis::Model::PutRecordsResultEntry::GetSequenceNumber ( ) const
inline

The sequence number for an individual record result.

Definition at line 47 of file PutRecordsResultEntry.h.

◆ GetShardId()

const Aws::String& Aws::Kinesis::Model::PutRecordsResultEntry::GetShardId ( ) const
inline

The shard ID for an individual record result.

Definition at line 88 of file PutRecordsResultEntry.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SequenceNumberHasBeenSet()

bool Aws::Kinesis::Model::PutRecordsResultEntry::SequenceNumberHasBeenSet ( ) const
inline

The sequence number for an individual record result.

Definition at line 52 of file PutRecordsResultEntry.h.

◆ SetErrorCode() [1/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetErrorCode ( Aws::String &&  value)
inline

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

Definition at line 152 of file PutRecordsResultEntry.h.

◆ SetErrorCode() [2/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetErrorCode ( const Aws::String value)
inline

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

Definition at line 145 of file PutRecordsResultEntry.h.

◆ SetErrorCode() [3/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetErrorCode ( const char *  value)
inline

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

Definition at line 159 of file PutRecordsResultEntry.h.

◆ SetErrorMessage() [1/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetErrorMessage ( Aws::String &&  value)
inline

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

Definition at line 217 of file PutRecordsResultEntry.h.

◆ SetErrorMessage() [2/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetErrorMessage ( const Aws::String value)
inline

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

Definition at line 208 of file PutRecordsResultEntry.h.

◆ SetErrorMessage() [3/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetErrorMessage ( const char *  value)
inline

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

Definition at line 226 of file PutRecordsResultEntry.h.

◆ SetSequenceNumber() [1/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetSequenceNumber ( Aws::String &&  value)
inline

The sequence number for an individual record result.

Definition at line 62 of file PutRecordsResultEntry.h.

◆ SetSequenceNumber() [2/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetSequenceNumber ( const Aws::String value)
inline

The sequence number for an individual record result.

Definition at line 57 of file PutRecordsResultEntry.h.

◆ SetSequenceNumber() [3/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetSequenceNumber ( const char *  value)
inline

The sequence number for an individual record result.

Definition at line 67 of file PutRecordsResultEntry.h.

◆ SetShardId() [1/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetShardId ( Aws::String &&  value)
inline

The shard ID for an individual record result.

Definition at line 103 of file PutRecordsResultEntry.h.

◆ SetShardId() [2/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetShardId ( const Aws::String value)
inline

The shard ID for an individual record result.

Definition at line 98 of file PutRecordsResultEntry.h.

◆ SetShardId() [3/3]

void Aws::Kinesis::Model::PutRecordsResultEntry::SetShardId ( const char *  value)
inline

The shard ID for an individual record result.

Definition at line 108 of file PutRecordsResultEntry.h.

◆ ShardIdHasBeenSet()

bool Aws::Kinesis::Model::PutRecordsResultEntry::ShardIdHasBeenSet ( ) const
inline

The shard ID for an individual record result.

Definition at line 93 of file PutRecordsResultEntry.h.

◆ WithErrorCode() [1/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithErrorCode ( Aws::String &&  value)
inline

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

Definition at line 173 of file PutRecordsResultEntry.h.

◆ WithErrorCode() [2/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithErrorCode ( const Aws::String value)
inline

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

Definition at line 166 of file PutRecordsResultEntry.h.

◆ WithErrorCode() [3/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithErrorCode ( const char *  value)
inline

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

Definition at line 180 of file PutRecordsResultEntry.h.

◆ WithErrorMessage() [1/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithErrorMessage ( Aws::String &&  value)
inline

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

Definition at line 244 of file PutRecordsResultEntry.h.

◆ WithErrorMessage() [2/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithErrorMessage ( const Aws::String value)
inline

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

Definition at line 235 of file PutRecordsResultEntry.h.

◆ WithErrorMessage() [3/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithErrorMessage ( const char *  value)
inline

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

Definition at line 253 of file PutRecordsResultEntry.h.

◆ WithSequenceNumber() [1/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithSequenceNumber ( Aws::String &&  value)
inline

The sequence number for an individual record result.

Definition at line 77 of file PutRecordsResultEntry.h.

◆ WithSequenceNumber() [2/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithSequenceNumber ( const Aws::String value)
inline

The sequence number for an individual record result.

Definition at line 72 of file PutRecordsResultEntry.h.

◆ WithSequenceNumber() [3/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithSequenceNumber ( const char *  value)
inline

The sequence number for an individual record result.

Definition at line 82 of file PutRecordsResultEntry.h.

◆ WithShardId() [1/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithShardId ( Aws::String &&  value)
inline

The shard ID for an individual record result.

Definition at line 118 of file PutRecordsResultEntry.h.

◆ WithShardId() [2/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithShardId ( const Aws::String value)
inline

The shard ID for an individual record result.

Definition at line 113 of file PutRecordsResultEntry.h.

◆ WithShardId() [3/3]

PutRecordsResultEntry& Aws::Kinesis::Model::PutRecordsResultEntry::WithShardId ( const char *  value)
inline

The shard ID for an individual record result.

Definition at line 123 of file PutRecordsResultEntry.h.


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