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

#include <ConsumerDescription.h>

Public Member Functions

 ConsumerDescription ()
 
 ConsumerDescription (Aws::Utils::Json::JsonView jsonValue)
 
ConsumerDescriptionoperator= (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)
 
ConsumerDescriptionWithConsumerName (const Aws::String &value)
 
ConsumerDescriptionWithConsumerName (Aws::String &&value)
 
ConsumerDescriptionWithConsumerName (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)
 
ConsumerDescriptionWithConsumerARN (const Aws::String &value)
 
ConsumerDescriptionWithConsumerARN (Aws::String &&value)
 
ConsumerDescriptionWithConsumerARN (const char *value)
 
const ConsumerStatusGetConsumerStatus () const
 
bool ConsumerStatusHasBeenSet () const
 
void SetConsumerStatus (const ConsumerStatus &value)
 
void SetConsumerStatus (ConsumerStatus &&value)
 
ConsumerDescriptionWithConsumerStatus (const ConsumerStatus &value)
 
ConsumerDescriptionWithConsumerStatus (ConsumerStatus &&value)
 
const Aws::Utils::DateTimeGetConsumerCreationTimestamp () const
 
bool ConsumerCreationTimestampHasBeenSet () const
 
void SetConsumerCreationTimestamp (const Aws::Utils::DateTime &value)
 
void SetConsumerCreationTimestamp (Aws::Utils::DateTime &&value)
 
ConsumerDescriptionWithConsumerCreationTimestamp (const Aws::Utils::DateTime &value)
 
ConsumerDescriptionWithConsumerCreationTimestamp (Aws::Utils::DateTime &&value)
 
const Aws::StringGetStreamARN () const
 
bool StreamARNHasBeenSet () const
 
void SetStreamARN (const Aws::String &value)
 
void SetStreamARN (Aws::String &&value)
 
void SetStreamARN (const char *value)
 
ConsumerDescriptionWithStreamARN (const Aws::String &value)
 
ConsumerDescriptionWithStreamARN (Aws::String &&value)
 
ConsumerDescriptionWithStreamARN (const char *value)
 

Detailed Description

An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.

See Also:


AWS API Reference

Definition at line 35 of file ConsumerDescription.h.

Constructor & Destructor Documentation

◆ ConsumerDescription() [1/2]

Aws::Kinesis::Model::ConsumerDescription::ConsumerDescription ( )

◆ ConsumerDescription() [2/2]

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

Member Function Documentation

◆ ConsumerARNHasBeenSet()

bool Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ ConsumerCreationTimestampHasBeenSet()

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

Definition at line 219 of file ConsumerDescription.h.

◆ ConsumerNameHasBeenSet()

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

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

Definition at line 54 of file ConsumerDescription.h.

◆ ConsumerStatusHasBeenSet()

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

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

Definition at line 184 of file ConsumerDescription.h.

◆ GetConsumerARN()

const Aws::String& Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ GetConsumerCreationTimestamp()

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

Definition at line 214 of file ConsumerDescription.h.

◆ GetConsumerName()

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

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

Definition at line 48 of file ConsumerDescription.h.

◆ GetConsumerStatus()

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

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

Definition at line 178 of file ConsumerDescription.h.

◆ GetStreamARN()

const Aws::String& Aws::Kinesis::Model::ConsumerDescription::GetStreamARN ( ) const
inline

The ARN of the stream with which you registered the consumer.

Definition at line 245 of file ConsumerDescription.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetConsumerARN() [1/3]

void Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ SetConsumerARN() [2/3]

void Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ SetConsumerARN() [3/3]

void Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ SetConsumerCreationTimestamp() [1/2]

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

Definition at line 229 of file ConsumerDescription.h.

◆ SetConsumerCreationTimestamp() [2/2]

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

Definition at line 224 of file ConsumerDescription.h.

◆ SetConsumerName() [1/3]

void Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ SetConsumerName() [2/3]

void Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ SetConsumerName() [3/3]

void Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ SetConsumerStatus() [1/2]

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

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

Definition at line 190 of file ConsumerDescription.h.

◆ SetConsumerStatus() [2/2]

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

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

Definition at line 196 of file ConsumerDescription.h.

◆ SetStreamARN() [1/3]

void Aws::Kinesis::Model::ConsumerDescription::SetStreamARN ( Aws::String &&  value)
inline

The ARN of the stream with which you registered the consumer.

Definition at line 260 of file ConsumerDescription.h.

◆ SetStreamARN() [2/3]

void Aws::Kinesis::Model::ConsumerDescription::SetStreamARN ( const Aws::String value)
inline

The ARN of the stream with which you registered the consumer.

Definition at line 255 of file ConsumerDescription.h.

◆ SetStreamARN() [3/3]

void Aws::Kinesis::Model::ConsumerDescription::SetStreamARN ( const char *  value)
inline

The ARN of the stream with which you registered the consumer.

Definition at line 265 of file ConsumerDescription.h.

◆ StreamARNHasBeenSet()

bool Aws::Kinesis::Model::ConsumerDescription::StreamARNHasBeenSet ( ) const
inline

The ARN of the stream with which you registered the consumer.

Definition at line 250 of file ConsumerDescription.h.

◆ WithConsumerARN() [1/3]

ConsumerDescription& Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ WithConsumerARN() [2/3]

ConsumerDescription& Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ WithConsumerARN() [3/3]

ConsumerDescription& Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ WithConsumerCreationTimestamp() [1/2]

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

Definition at line 239 of file ConsumerDescription.h.

◆ WithConsumerCreationTimestamp() [2/2]

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

Definition at line 234 of file ConsumerDescription.h.

◆ WithConsumerName() [1/3]

ConsumerDescription& Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ WithConsumerName() [2/3]

ConsumerDescription& Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ WithConsumerName() [3/3]

ConsumerDescription& Aws::Kinesis::Model::ConsumerDescription::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 ConsumerDescription.h.

◆ WithConsumerStatus() [1/2]

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

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

Definition at line 202 of file ConsumerDescription.h.

◆ WithConsumerStatus() [2/2]

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

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

Definition at line 208 of file ConsumerDescription.h.

◆ WithStreamARN() [1/3]

ConsumerDescription& Aws::Kinesis::Model::ConsumerDescription::WithStreamARN ( Aws::String &&  value)
inline

The ARN of the stream with which you registered the consumer.

Definition at line 275 of file ConsumerDescription.h.

◆ WithStreamARN() [2/3]

ConsumerDescription& Aws::Kinesis::Model::ConsumerDescription::WithStreamARN ( const Aws::String value)
inline

The ARN of the stream with which you registered the consumer.

Definition at line 270 of file ConsumerDescription.h.

◆ WithStreamARN() [3/3]

ConsumerDescription& Aws::Kinesis::Model::ConsumerDescription::WithStreamARN ( const char *  value)
inline

The ARN of the stream with which you registered the consumer.

Definition at line 280 of file ConsumerDescription.h.


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