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

#include <GetRecordsResult.h>

Public Member Functions

 GetRecordsResult ()
 
 GetRecordsResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetRecordsResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::Vector< Record > & GetRecords () const
 
void SetRecords (const Aws::Vector< Record > &value)
 
void SetRecords (Aws::Vector< Record > &&value)
 
GetRecordsResultWithRecords (const Aws::Vector< Record > &value)
 
GetRecordsResultWithRecords (Aws::Vector< Record > &&value)
 
GetRecordsResultAddRecords (const Record &value)
 
GetRecordsResultAddRecords (Record &&value)
 
const Aws::StringGetNextShardIterator () const
 
void SetNextShardIterator (const Aws::String &value)
 
void SetNextShardIterator (Aws::String &&value)
 
void SetNextShardIterator (const char *value)
 
GetRecordsResultWithNextShardIterator (const Aws::String &value)
 
GetRecordsResultWithNextShardIterator (Aws::String &&value)
 
GetRecordsResultWithNextShardIterator (const char *value)
 
long long GetMillisBehindLatest () const
 
void SetMillisBehindLatest (long long value)
 
GetRecordsResultWithMillisBehindLatest (long long value)
 
const Aws::Vector< ChildShard > & GetChildShards () const
 
void SetChildShards (const Aws::Vector< ChildShard > &value)
 
void SetChildShards (Aws::Vector< ChildShard > &&value)
 
GetRecordsResultWithChildShards (const Aws::Vector< ChildShard > &value)
 
GetRecordsResultWithChildShards (Aws::Vector< ChildShard > &&value)
 
GetRecordsResultAddChildShards (const ChildShard &value)
 
GetRecordsResultAddChildShards (ChildShard &&value)
 

Detailed Description

Represents the output for GetRecords.

See Also:

AWS API Reference

Definition at line 35 of file GetRecordsResult.h.

Constructor & Destructor Documentation

◆ GetRecordsResult() [1/2]

Aws::Kinesis::Model::GetRecordsResult::GetRecordsResult ( )

◆ GetRecordsResult() [2/2]

Aws::Kinesis::Model::GetRecordsResult::GetRecordsResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddChildShards() [1/2]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::AddChildShards ( ChildShard &&  value)
inline

Definition at line 173 of file GetRecordsResult.h.

◆ AddChildShards() [2/2]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::AddChildShards ( const ChildShard value)
inline

Definition at line 170 of file GetRecordsResult.h.

◆ AddRecords() [1/2]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::AddRecords ( const Record value)
inline

The data records retrieved from the shard.

Definition at line 71 of file GetRecordsResult.h.

◆ AddRecords() [2/2]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::AddRecords ( Record &&  value)
inline

The data records retrieved from the shard.

Definition at line 76 of file GetRecordsResult.h.

◆ GetChildShards()

const Aws::Vector<ChildShard>& Aws::Kinesis::Model::GetRecordsResult::GetChildShards ( ) const
inline

Definition at line 155 of file GetRecordsResult.h.

◆ GetMillisBehindLatest()

long long Aws::Kinesis::Model::GetRecordsResult::GetMillisBehindLatest ( ) const
inline

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

Definition at line 135 of file GetRecordsResult.h.

◆ GetNextShardIterator()

const Aws::String& Aws::Kinesis::Model::GetRecordsResult::GetNextShardIterator ( ) const
inline

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

Definition at line 84 of file GetRecordsResult.h.

◆ GetRecords()

const Aws::Vector<Record>& Aws::Kinesis::Model::GetRecordsResult::GetRecords ( ) const
inline

The data records retrieved from the shard.

Definition at line 46 of file GetRecordsResult.h.

◆ operator=()

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetChildShards() [1/2]

void Aws::Kinesis::Model::GetRecordsResult::SetChildShards ( Aws::Vector< ChildShard > &&  value)
inline

Definition at line 161 of file GetRecordsResult.h.

◆ SetChildShards() [2/2]

void Aws::Kinesis::Model::GetRecordsResult::SetChildShards ( const Aws::Vector< ChildShard > &  value)
inline

Definition at line 158 of file GetRecordsResult.h.

◆ SetMillisBehindLatest()

void Aws::Kinesis::Model::GetRecordsResult::SetMillisBehindLatest ( long long  value)
inline

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

Definition at line 143 of file GetRecordsResult.h.

◆ SetNextShardIterator() [1/3]

void Aws::Kinesis::Model::GetRecordsResult::SetNextShardIterator ( Aws::String &&  value)
inline

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

Definition at line 98 of file GetRecordsResult.h.

◆ SetNextShardIterator() [2/3]

void Aws::Kinesis::Model::GetRecordsResult::SetNextShardIterator ( const Aws::String value)
inline

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

Definition at line 91 of file GetRecordsResult.h.

◆ SetNextShardIterator() [3/3]

void Aws::Kinesis::Model::GetRecordsResult::SetNextShardIterator ( const char *  value)
inline

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

Definition at line 105 of file GetRecordsResult.h.

◆ SetRecords() [1/2]

void Aws::Kinesis::Model::GetRecordsResult::SetRecords ( Aws::Vector< Record > &&  value)
inline

The data records retrieved from the shard.

Definition at line 56 of file GetRecordsResult.h.

◆ SetRecords() [2/2]

void Aws::Kinesis::Model::GetRecordsResult::SetRecords ( const Aws::Vector< Record > &  value)
inline

The data records retrieved from the shard.

Definition at line 51 of file GetRecordsResult.h.

◆ WithChildShards() [1/2]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::WithChildShards ( Aws::Vector< ChildShard > &&  value)
inline

Definition at line 167 of file GetRecordsResult.h.

◆ WithChildShards() [2/2]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::WithChildShards ( const Aws::Vector< ChildShard > &  value)
inline

Definition at line 164 of file GetRecordsResult.h.

◆ WithMillisBehindLatest()

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::WithMillisBehindLatest ( long long  value)
inline

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

Definition at line 151 of file GetRecordsResult.h.

◆ WithNextShardIterator() [1/3]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::WithNextShardIterator ( Aws::String &&  value)
inline

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

Definition at line 119 of file GetRecordsResult.h.

◆ WithNextShardIterator() [2/3]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::WithNextShardIterator ( const Aws::String value)
inline

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

Definition at line 112 of file GetRecordsResult.h.

◆ WithNextShardIterator() [3/3]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::WithNextShardIterator ( const char *  value)
inline

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

Definition at line 126 of file GetRecordsResult.h.

◆ WithRecords() [1/2]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::WithRecords ( Aws::Vector< Record > &&  value)
inline

The data records retrieved from the shard.

Definition at line 66 of file GetRecordsResult.h.

◆ WithRecords() [2/2]

GetRecordsResult& Aws::Kinesis::Model::GetRecordsResult::WithRecords ( const Aws::Vector< Record > &  value)
inline

The data records retrieved from the shard.

Definition at line 61 of file GetRecordsResult.h.


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