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

#include <Record.h>

Public Member Functions

 Record ()
 
 Record (Aws::Utils::Json::JsonView jsonValue)
 
Recordoperator= (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)
 
RecordWithSequenceNumber (const Aws::String &value)
 
RecordWithSequenceNumber (Aws::String &&value)
 
RecordWithSequenceNumber (const char *value)
 
const Aws::Utils::DateTimeGetApproximateArrivalTimestamp () const
 
bool ApproximateArrivalTimestampHasBeenSet () const
 
void SetApproximateArrivalTimestamp (const Aws::Utils::DateTime &value)
 
void SetApproximateArrivalTimestamp (Aws::Utils::DateTime &&value)
 
RecordWithApproximateArrivalTimestamp (const Aws::Utils::DateTime &value)
 
RecordWithApproximateArrivalTimestamp (Aws::Utils::DateTime &&value)
 
const Aws::Utils::ByteBufferGetData () const
 
bool DataHasBeenSet () const
 
void SetData (const Aws::Utils::ByteBuffer &value)
 
void SetData (Aws::Utils::ByteBuffer &&value)
 
RecordWithData (const Aws::Utils::ByteBuffer &value)
 
RecordWithData (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)
 
RecordWithPartitionKey (const Aws::String &value)
 
RecordWithPartitionKey (Aws::String &&value)
 
RecordWithPartitionKey (const char *value)
 
const EncryptionTypeGetEncryptionType () const
 
bool EncryptionTypeHasBeenSet () const
 
void SetEncryptionType (const EncryptionType &value)
 
void SetEncryptionType (EncryptionType &&value)
 
RecordWithEncryptionType (const EncryptionType &value)
 
RecordWithEncryptionType (EncryptionType &&value)
 

Detailed Description

The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.

See Also:

AWS API Reference

Definition at line 35 of file Record.h.

Constructor & Destructor Documentation

◆ Record() [1/2]

Aws::Kinesis::Model::Record::Record ( )

◆ Record() [2/2]

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

Member Function Documentation

◆ ApproximateArrivalTimestampHasBeenSet()

bool Aws::Kinesis::Model::Record::ApproximateArrivalTimestampHasBeenSet ( ) const
inline

The approximate time that the record was inserted into the stream.

Definition at line 93 of file Record.h.

◆ DataHasBeenSet()

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

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. 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 132 of file Record.h.

◆ EncryptionTypeHasBeenSet()

bool Aws::Kinesis::Model::Record::EncryptionTypeHasBeenSet ( ) const
inline

The encryption type used on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 228 of file Record.h.

◆ GetApproximateArrivalTimestamp()

const Aws::Utils::DateTime& Aws::Kinesis::Model::Record::GetApproximateArrivalTimestamp ( ) const
inline

The approximate time that the record was inserted into the stream.

Definition at line 88 of file Record.h.

◆ GetData()

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

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. 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 123 of file Record.h.

◆ GetEncryptionType()

const EncryptionType& Aws::Kinesis::Model::Record::GetEncryptionType ( ) const
inline

The encryption type used on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 219 of file Record.h.

◆ GetPartitionKey()

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

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

Definition at line 174 of file Record.h.

◆ GetSequenceNumber()

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

The unique identifier of the record within its shard.

Definition at line 47 of file Record.h.

◆ Jsonize()

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

◆ operator=()

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

◆ PartitionKeyHasBeenSet()

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

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

Definition at line 179 of file Record.h.

◆ SequenceNumberHasBeenSet()

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

The unique identifier of the record within its shard.

Definition at line 52 of file Record.h.

◆ SetApproximateArrivalTimestamp() [1/2]

void Aws::Kinesis::Model::Record::SetApproximateArrivalTimestamp ( Aws::Utils::DateTime &&  value)
inline

The approximate time that the record was inserted into the stream.

Definition at line 103 of file Record.h.

◆ SetApproximateArrivalTimestamp() [2/2]

void Aws::Kinesis::Model::Record::SetApproximateArrivalTimestamp ( const Aws::Utils::DateTime value)
inline

The approximate time that the record was inserted into the stream.

Definition at line 98 of file Record.h.

◆ SetData() [1/2]

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

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. 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 150 of file Record.h.

◆ SetData() [2/2]

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

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. 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 141 of file Record.h.

◆ SetEncryptionType() [1/2]

void Aws::Kinesis::Model::Record::SetEncryptionType ( const EncryptionType value)
inline

The encryption type used on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 237 of file Record.h.

◆ SetEncryptionType() [2/2]

void Aws::Kinesis::Model::Record::SetEncryptionType ( EncryptionType &&  value)
inline

The encryption type used on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 246 of file Record.h.

◆ SetPartitionKey() [1/3]

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

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

Definition at line 189 of file Record.h.

◆ SetPartitionKey() [2/3]

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

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

Definition at line 184 of file Record.h.

◆ SetPartitionKey() [3/3]

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

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

Definition at line 194 of file Record.h.

◆ SetSequenceNumber() [1/3]

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

The unique identifier of the record within its shard.

Definition at line 62 of file Record.h.

◆ SetSequenceNumber() [2/3]

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

The unique identifier of the record within its shard.

Definition at line 57 of file Record.h.

◆ SetSequenceNumber() [3/3]

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

The unique identifier of the record within its shard.

Definition at line 67 of file Record.h.

◆ WithApproximateArrivalTimestamp() [1/2]

Record& Aws::Kinesis::Model::Record::WithApproximateArrivalTimestamp ( Aws::Utils::DateTime &&  value)
inline

The approximate time that the record was inserted into the stream.

Definition at line 113 of file Record.h.

◆ WithApproximateArrivalTimestamp() [2/2]

Record& Aws::Kinesis::Model::Record::WithApproximateArrivalTimestamp ( const Aws::Utils::DateTime value)
inline

The approximate time that the record was inserted into the stream.

Definition at line 108 of file Record.h.

◆ WithData() [1/2]

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

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. 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 168 of file Record.h.

◆ WithData() [2/2]

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

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. 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 159 of file Record.h.

◆ WithEncryptionType() [1/2]

Record& Aws::Kinesis::Model::Record::WithEncryptionType ( const EncryptionType value)
inline

The encryption type used on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 255 of file Record.h.

◆ WithEncryptionType() [2/2]

Record& Aws::Kinesis::Model::Record::WithEncryptionType ( EncryptionType &&  value)
inline

The encryption type used on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

Definition at line 264 of file Record.h.

◆ WithPartitionKey() [1/3]

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

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

Definition at line 204 of file Record.h.

◆ WithPartitionKey() [2/3]

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

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

Definition at line 199 of file Record.h.

◆ WithPartitionKey() [3/3]

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

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

Definition at line 209 of file Record.h.

◆ WithSequenceNumber() [1/3]

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

The unique identifier of the record within its shard.

Definition at line 77 of file Record.h.

◆ WithSequenceNumber() [2/3]

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

The unique identifier of the record within its shard.

Definition at line 72 of file Record.h.

◆ WithSequenceNumber() [3/3]

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

The unique identifier of the record within its shard.

Definition at line 82 of file Record.h.


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