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

#include <Consumer.h>

Public Member Functions

 Consumer ()
 
 Consumer (Aws::Utils::Json::JsonView jsonValue)
 
Consumeroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetConsumerName () const
 
bool ConsumerNameHasBeenSet () const
 
void SetConsumerName (const Aws::String &value)
 
void SetConsumerName (Aws::String &&value)
 
void SetConsumerName (const char *value)
 
ConsumerWithConsumerName (const Aws::String &value)
 
ConsumerWithConsumerName (Aws::String &&value)
 
ConsumerWithConsumerName (const char *value)
 
const Aws::StringGetConsumerARN () const
 
bool ConsumerARNHasBeenSet () const
 
void SetConsumerARN (const Aws::String &value)
 
void SetConsumerARN (Aws::String &&value)
 
void SetConsumerARN (const char *value)
 
ConsumerWithConsumerARN (const Aws::String &value)
 
ConsumerWithConsumerARN (Aws::String &&value)
 
ConsumerWithConsumerARN (const char *value)
 
const ConsumerStatusGetConsumerStatus () const
 
bool ConsumerStatusHasBeenSet () const
 
void SetConsumerStatus (const ConsumerStatus &value)
 
void SetConsumerStatus (ConsumerStatus &&value)
 
ConsumerWithConsumerStatus (const ConsumerStatus &value)
 
ConsumerWithConsumerStatus (ConsumerStatus &&value)
 
const Aws::Utils::DateTimeGetConsumerCreationTimestamp () const
 
bool ConsumerCreationTimestampHasBeenSet () const
 
void SetConsumerCreationTimestamp (const Aws::Utils::DateTime &value)
 
void SetConsumerCreationTimestamp (Aws::Utils::DateTime &&value)
 
ConsumerWithConsumerCreationTimestamp (const Aws::Utils::DateTime &value)
 
ConsumerWithConsumerCreationTimestamp (Aws::Utils::DateTime &&value)
 

Detailed Description

An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.

See Also:

AWS API Reference

Definition at line 35 of file Consumer.h.

Constructor & Destructor Documentation

◆ Consumer() [1/2]

Aws::Kinesis::Model::Consumer::Consumer ( )

◆ Consumer() [2/2]

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

Member Function Documentation

◆ ConsumerARNHasBeenSet()

bool Aws::Kinesis::Model::Consumer::ConsumerARNHasBeenSet ( ) const
inline

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

Definition at line 111 of file Consumer.h.

◆ ConsumerCreationTimestampHasBeenSet()

bool Aws::Kinesis::Model::Consumer::ConsumerCreationTimestampHasBeenSet ( ) const
inline

Definition at line 219 of file Consumer.h.

◆ ConsumerNameHasBeenSet()

bool Aws::Kinesis::Model::Consumer::ConsumerNameHasBeenSet ( ) const
inline

The name of the consumer is something you choose when you register the consumer.

Definition at line 54 of file Consumer.h.

◆ ConsumerStatusHasBeenSet()

bool Aws::Kinesis::Model::Consumer::ConsumerStatusHasBeenSet ( ) const
inline

A consumer can't read data while in the CREATING or DELETING states.

Definition at line 184 of file Consumer.h.

◆ GetConsumerARN()

const Aws::String& Aws::Kinesis::Model::Consumer::GetConsumerARN ( ) const
inline

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

Definition at line 101 of file Consumer.h.

◆ GetConsumerCreationTimestamp()

const Aws::Utils::DateTime& Aws::Kinesis::Model::Consumer::GetConsumerCreationTimestamp ( ) const
inline

Definition at line 214 of file Consumer.h.

◆ GetConsumerName()

const Aws::String& Aws::Kinesis::Model::Consumer::GetConsumerName ( ) const
inline

The name of the consumer is something you choose when you register the consumer.

Definition at line 48 of file Consumer.h.

◆ GetConsumerStatus()

const ConsumerStatus& Aws::Kinesis::Model::Consumer::GetConsumerStatus ( ) const
inline

A consumer can't read data while in the CREATING or DELETING states.

Definition at line 178 of file Consumer.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetConsumerARN() [1/3]

void Aws::Kinesis::Model::Consumer::SetConsumerARN ( Aws::String &&  value)
inline

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

Definition at line 131 of file Consumer.h.

◆ SetConsumerARN() [2/3]

void Aws::Kinesis::Model::Consumer::SetConsumerARN ( const Aws::String value)
inline

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

Definition at line 121 of file Consumer.h.

◆ SetConsumerARN() [3/3]

void Aws::Kinesis::Model::Consumer::SetConsumerARN ( const char *  value)
inline

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

Definition at line 141 of file Consumer.h.

◆ SetConsumerCreationTimestamp() [1/2]

void Aws::Kinesis::Model::Consumer::SetConsumerCreationTimestamp ( Aws::Utils::DateTime &&  value)
inline

Definition at line 229 of file Consumer.h.

◆ SetConsumerCreationTimestamp() [2/2]

void Aws::Kinesis::Model::Consumer::SetConsumerCreationTimestamp ( const Aws::Utils::DateTime value)
inline

Definition at line 224 of file Consumer.h.

◆ SetConsumerName() [1/3]

void Aws::Kinesis::Model::Consumer::SetConsumerName ( Aws::String &&  value)
inline

The name of the consumer is something you choose when you register the consumer.

Definition at line 66 of file Consumer.h.

◆ SetConsumerName() [2/3]

void Aws::Kinesis::Model::Consumer::SetConsumerName ( const Aws::String value)
inline

The name of the consumer is something you choose when you register the consumer.

Definition at line 60 of file Consumer.h.

◆ SetConsumerName() [3/3]

void Aws::Kinesis::Model::Consumer::SetConsumerName ( const char *  value)
inline

The name of the consumer is something you choose when you register the consumer.

Definition at line 72 of file Consumer.h.

◆ SetConsumerStatus() [1/2]

void Aws::Kinesis::Model::Consumer::SetConsumerStatus ( const ConsumerStatus value)
inline

A consumer can't read data while in the CREATING or DELETING states.

Definition at line 190 of file Consumer.h.

◆ SetConsumerStatus() [2/2]

void Aws::Kinesis::Model::Consumer::SetConsumerStatus ( ConsumerStatus &&  value)
inline

A consumer can't read data while in the CREATING or DELETING states.

Definition at line 196 of file Consumer.h.

◆ WithConsumerARN() [1/3]

Consumer& Aws::Kinesis::Model::Consumer::WithConsumerARN ( Aws::String &&  value)
inline

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

Definition at line 161 of file Consumer.h.

◆ WithConsumerARN() [2/3]

Consumer& Aws::Kinesis::Model::Consumer::WithConsumerARN ( const Aws::String value)
inline

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

Definition at line 151 of file Consumer.h.

◆ WithConsumerARN() [3/3]

Consumer& Aws::Kinesis::Model::Consumer::WithConsumerARN ( const char *  value)
inline

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

Definition at line 171 of file Consumer.h.

◆ WithConsumerCreationTimestamp() [1/2]

Consumer& Aws::Kinesis::Model::Consumer::WithConsumerCreationTimestamp ( Aws::Utils::DateTime &&  value)
inline

Definition at line 239 of file Consumer.h.

◆ WithConsumerCreationTimestamp() [2/2]

Consumer& Aws::Kinesis::Model::Consumer::WithConsumerCreationTimestamp ( const Aws::Utils::DateTime value)
inline

Definition at line 234 of file Consumer.h.

◆ WithConsumerName() [1/3]

Consumer& Aws::Kinesis::Model::Consumer::WithConsumerName ( Aws::String &&  value)
inline

The name of the consumer is something you choose when you register the consumer.

Definition at line 84 of file Consumer.h.

◆ WithConsumerName() [2/3]

Consumer& Aws::Kinesis::Model::Consumer::WithConsumerName ( const Aws::String value)
inline

The name of the consumer is something you choose when you register the consumer.

Definition at line 78 of file Consumer.h.

◆ WithConsumerName() [3/3]

Consumer& Aws::Kinesis::Model::Consumer::WithConsumerName ( const char *  value)
inline

The name of the consumer is something you choose when you register the consumer.

Definition at line 90 of file Consumer.h.

◆ WithConsumerStatus() [1/2]

Consumer& Aws::Kinesis::Model::Consumer::WithConsumerStatus ( const ConsumerStatus value)
inline

A consumer can't read data while in the CREATING or DELETING states.

Definition at line 202 of file Consumer.h.

◆ WithConsumerStatus() [2/2]

Consumer& Aws::Kinesis::Model::Consumer::WithConsumerStatus ( ConsumerStatus &&  value)
inline

A consumer can't read data while in the CREATING or DELETING states.

Definition at line 208 of file Consumer.h.


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