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

#include <ListStreamConsumersResult.h>

Public Member Functions

 ListStreamConsumersResult ()
 
 ListStreamConsumersResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
ListStreamConsumersResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::Vector< Consumer > & GetConsumers () const
 
void SetConsumers (const Aws::Vector< Consumer > &value)
 
void SetConsumers (Aws::Vector< Consumer > &&value)
 
ListStreamConsumersResultWithConsumers (const Aws::Vector< Consumer > &value)
 
ListStreamConsumersResultWithConsumers (Aws::Vector< Consumer > &&value)
 
ListStreamConsumersResultAddConsumers (const Consumer &value)
 
ListStreamConsumersResultAddConsumers (Consumer &&value)
 
const Aws::StringGetNextToken () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListStreamConsumersResultWithNextToken (const Aws::String &value)
 
ListStreamConsumersResultWithNextToken (Aws::String &&value)
 
ListStreamConsumersResultWithNextToken (const char *value)
 

Detailed Description

Definition at line 29 of file ListStreamConsumersResult.h.

Constructor & Destructor Documentation

◆ ListStreamConsumersResult() [1/2]

Aws::Kinesis::Model::ListStreamConsumersResult::ListStreamConsumersResult ( )

◆ ListStreamConsumersResult() [2/2]

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

Member Function Documentation

◆ AddConsumers() [1/2]

ListStreamConsumersResult& Aws::Kinesis::Model::ListStreamConsumersResult::AddConsumers ( const Consumer value)
inline

An array of JSON objects. Each object represents one registered consumer.

Definition at line 65 of file ListStreamConsumersResult.h.

◆ AddConsumers() [2/2]

ListStreamConsumersResult& Aws::Kinesis::Model::ListStreamConsumersResult::AddConsumers ( Consumer &&  value)
inline

An array of JSON objects. Each object represents one registered consumer.

Definition at line 70 of file ListStreamConsumersResult.h.

◆ GetConsumers()

const Aws::Vector<Consumer>& Aws::Kinesis::Model::ListStreamConsumersResult::GetConsumers ( ) const
inline

An array of JSON objects. Each object represents one registered consumer.

Definition at line 40 of file ListStreamConsumersResult.h.

◆ GetNextToken()

const Aws::String& Aws::Kinesis::Model::ListStreamConsumersResult::GetNextToken ( ) const
inline

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

Definition at line 89 of file ListStreamConsumersResult.h.

◆ operator=()

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

◆ SetConsumers() [1/2]

void Aws::Kinesis::Model::ListStreamConsumersResult::SetConsumers ( Aws::Vector< Consumer > &&  value)
inline

An array of JSON objects. Each object represents one registered consumer.

Definition at line 50 of file ListStreamConsumersResult.h.

◆ SetConsumers() [2/2]

void Aws::Kinesis::Model::ListStreamConsumersResult::SetConsumers ( const Aws::Vector< Consumer > &  value)
inline

An array of JSON objects. Each object represents one registered consumer.

Definition at line 45 of file ListStreamConsumersResult.h.

◆ SetNextToken() [1/3]

void Aws::Kinesis::Model::ListStreamConsumersResult::SetNextToken ( Aws::String &&  value)
inline

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

Definition at line 125 of file ListStreamConsumersResult.h.

◆ SetNextToken() [2/3]

void Aws::Kinesis::Model::ListStreamConsumersResult::SetNextToken ( const Aws::String value)
inline

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

Definition at line 107 of file ListStreamConsumersResult.h.

◆ SetNextToken() [3/3]

void Aws::Kinesis::Model::ListStreamConsumersResult::SetNextToken ( const char *  value)
inline

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

Definition at line 143 of file ListStreamConsumersResult.h.

◆ WithConsumers() [1/2]

ListStreamConsumersResult& Aws::Kinesis::Model::ListStreamConsumersResult::WithConsumers ( Aws::Vector< Consumer > &&  value)
inline

An array of JSON objects. Each object represents one registered consumer.

Definition at line 60 of file ListStreamConsumersResult.h.

◆ WithConsumers() [2/2]

ListStreamConsumersResult& Aws::Kinesis::Model::ListStreamConsumersResult::WithConsumers ( const Aws::Vector< Consumer > &  value)
inline

An array of JSON objects. Each object represents one registered consumer.

Definition at line 55 of file ListStreamConsumersResult.h.

◆ WithNextToken() [1/3]

ListStreamConsumersResult& Aws::Kinesis::Model::ListStreamConsumersResult::WithNextToken ( Aws::String &&  value)
inline

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

Definition at line 179 of file ListStreamConsumersResult.h.

◆ WithNextToken() [2/3]

ListStreamConsumersResult& Aws::Kinesis::Model::ListStreamConsumersResult::WithNextToken ( const Aws::String value)
inline

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

Definition at line 161 of file ListStreamConsumersResult.h.

◆ WithNextToken() [3/3]

ListStreamConsumersResult& Aws::Kinesis::Model::ListStreamConsumersResult::WithNextToken ( const char *  value)
inline

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

Definition at line 197 of file ListStreamConsumersResult.h.


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