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

#include <SubscribeToShardEvent.h>

Public Member Functions

 SubscribeToShardEvent ()
 
 SubscribeToShardEvent (Aws::Utils::Json::JsonView jsonValue)
 
SubscribeToShardEventoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< Record > & GetRecords () const
 
bool RecordsHasBeenSet () const
 
void SetRecords (const Aws::Vector< Record > &value)
 
void SetRecords (Aws::Vector< Record > &&value)
 
SubscribeToShardEventWithRecords (const Aws::Vector< Record > &value)
 
SubscribeToShardEventWithRecords (Aws::Vector< Record > &&value)
 
SubscribeToShardEventAddRecords (const Record &value)
 
SubscribeToShardEventAddRecords (Record &&value)
 
const Aws::StringGetContinuationSequenceNumber () const
 
bool ContinuationSequenceNumberHasBeenSet () const
 
void SetContinuationSequenceNumber (const Aws::String &value)
 
void SetContinuationSequenceNumber (Aws::String &&value)
 
void SetContinuationSequenceNumber (const char *value)
 
SubscribeToShardEventWithContinuationSequenceNumber (const Aws::String &value)
 
SubscribeToShardEventWithContinuationSequenceNumber (Aws::String &&value)
 
SubscribeToShardEventWithContinuationSequenceNumber (const char *value)
 
long long GetMillisBehindLatest () const
 
bool MillisBehindLatestHasBeenSet () const
 
void SetMillisBehindLatest (long long value)
 
SubscribeToShardEventWithMillisBehindLatest (long long value)
 
const Aws::Vector< ChildShard > & GetChildShards () const
 
bool ChildShardsHasBeenSet () const
 
void SetChildShards (const Aws::Vector< ChildShard > &value)
 
void SetChildShards (Aws::Vector< ChildShard > &&value)
 
SubscribeToShardEventWithChildShards (const Aws::Vector< ChildShard > &value)
 
SubscribeToShardEventWithChildShards (Aws::Vector< ChildShard > &&value)
 
SubscribeToShardEventAddChildShards (const ChildShard &value)
 
SubscribeToShardEventAddChildShards (ChildShard &&value)
 

Detailed Description

After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.

See Also:


AWS API Reference

Definition at line 36 of file SubscribeToShardEvent.h.

Constructor & Destructor Documentation

◆ SubscribeToShardEvent() [1/2]

Aws::Kinesis::Model::SubscribeToShardEvent::SubscribeToShardEvent ( )

◆ SubscribeToShardEvent() [2/2]

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

Member Function Documentation

◆ AddChildShards() [1/2]

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

Definition at line 214 of file SubscribeToShardEvent.h.

◆ AddChildShards() [2/2]

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

Definition at line 211 of file SubscribeToShardEvent.h.

◆ AddRecords() [1/2]

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

Definition at line 78 of file SubscribeToShardEvent.h.

◆ AddRecords() [2/2]

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

Definition at line 83 of file SubscribeToShardEvent.h.

◆ ChildShardsHasBeenSet()

bool Aws::Kinesis::Model::SubscribeToShardEvent::ChildShardsHasBeenSet ( ) const
inline

Definition at line 196 of file SubscribeToShardEvent.h.

◆ ContinuationSequenceNumberHasBeenSet()

bool Aws::Kinesis::Model::SubscribeToShardEvent::ContinuationSequenceNumberHasBeenSet ( ) const
inline

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

Definition at line 102 of file SubscribeToShardEvent.h.

◆ GetChildShards()

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

Definition at line 193 of file SubscribeToShardEvent.h.

◆ GetContinuationSequenceNumber()

const Aws::String& Aws::Kinesis::Model::SubscribeToShardEvent::GetContinuationSequenceNumber ( ) const
inline

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

Definition at line 93 of file SubscribeToShardEvent.h.

◆ GetMillisBehindLatest()

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

The number of milliseconds the read records are 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 165 of file SubscribeToShardEvent.h.

◆ GetRecords()

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

Definition at line 48 of file SubscribeToShardEvent.h.

◆ Jsonize()

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

◆ MillisBehindLatestHasBeenSet()

bool Aws::Kinesis::Model::SubscribeToShardEvent::MillisBehindLatestHasBeenSet ( ) const
inline

The number of milliseconds the read records are 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 173 of file SubscribeToShardEvent.h.

◆ operator=()

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

◆ RecordsHasBeenSet()

bool Aws::Kinesis::Model::SubscribeToShardEvent::RecordsHasBeenSet ( ) const
inline

Definition at line 53 of file SubscribeToShardEvent.h.

◆ SetChildShards() [1/2]

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

Definition at line 202 of file SubscribeToShardEvent.h.

◆ SetChildShards() [2/2]

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

Definition at line 199 of file SubscribeToShardEvent.h.

◆ SetContinuationSequenceNumber() [1/3]

void Aws::Kinesis::Model::SubscribeToShardEvent::SetContinuationSequenceNumber ( Aws::String &&  value)
inline

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

Definition at line 120 of file SubscribeToShardEvent.h.

◆ SetContinuationSequenceNumber() [2/3]

void Aws::Kinesis::Model::SubscribeToShardEvent::SetContinuationSequenceNumber ( const Aws::String value)
inline

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

Definition at line 111 of file SubscribeToShardEvent.h.

◆ SetContinuationSequenceNumber() [3/3]

void Aws::Kinesis::Model::SubscribeToShardEvent::SetContinuationSequenceNumber ( const char *  value)
inline

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

Definition at line 129 of file SubscribeToShardEvent.h.

◆ SetMillisBehindLatest()

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

The number of milliseconds the read records are 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 181 of file SubscribeToShardEvent.h.

◆ SetRecords() [1/2]

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

Definition at line 63 of file SubscribeToShardEvent.h.

◆ SetRecords() [2/2]

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

Definition at line 58 of file SubscribeToShardEvent.h.

◆ WithChildShards() [1/2]

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

Definition at line 208 of file SubscribeToShardEvent.h.

◆ WithChildShards() [2/2]

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

Definition at line 205 of file SubscribeToShardEvent.h.

◆ WithContinuationSequenceNumber() [1/3]

SubscribeToShardEvent& Aws::Kinesis::Model::SubscribeToShardEvent::WithContinuationSequenceNumber ( Aws::String &&  value)
inline

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

Definition at line 147 of file SubscribeToShardEvent.h.

◆ WithContinuationSequenceNumber() [2/3]

SubscribeToShardEvent& Aws::Kinesis::Model::SubscribeToShardEvent::WithContinuationSequenceNumber ( const Aws::String value)
inline

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

Definition at line 138 of file SubscribeToShardEvent.h.

◆ WithContinuationSequenceNumber() [3/3]

SubscribeToShardEvent& Aws::Kinesis::Model::SubscribeToShardEvent::WithContinuationSequenceNumber ( const char *  value)
inline

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

Definition at line 156 of file SubscribeToShardEvent.h.

◆ WithMillisBehindLatest()

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

The number of milliseconds the read records are 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 189 of file SubscribeToShardEvent.h.

◆ WithRecords() [1/2]

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

Definition at line 73 of file SubscribeToShardEvent.h.

◆ WithRecords() [2/2]

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

Definition at line 68 of file SubscribeToShardEvent.h.


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