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

#include <ListShardsResult.h>

Public Member Functions

 ListShardsResult ()
 
 ListShardsResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
ListShardsResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::Vector< Shard > & GetShards () const
 
void SetShards (const Aws::Vector< Shard > &value)
 
void SetShards (Aws::Vector< Shard > &&value)
 
ListShardsResultWithShards (const Aws::Vector< Shard > &value)
 
ListShardsResultWithShards (Aws::Vector< Shard > &&value)
 
ListShardsResultAddShards (const Shard &value)
 
ListShardsResultAddShards (Shard &&value)
 
const Aws::StringGetNextToken () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListShardsResultWithNextToken (const Aws::String &value)
 
ListShardsResultWithNextToken (Aws::String &&value)
 
ListShardsResultWithNextToken (const char *value)
 

Detailed Description

Definition at line 29 of file ListShardsResult.h.

Constructor & Destructor Documentation

◆ ListShardsResult() [1/2]

Aws::Kinesis::Model::ListShardsResult::ListShardsResult ( )

◆ ListShardsResult() [2/2]

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

Member Function Documentation

◆ AddShards() [1/2]

ListShardsResult& Aws::Kinesis::Model::ListShardsResult::AddShards ( const Shard value)
inline

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

Definition at line 83 of file ListShardsResult.h.

◆ AddShards() [2/2]

ListShardsResult& Aws::Kinesis::Model::ListShardsResult::AddShards ( Shard &&  value)
inline

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

Definition at line 91 of file ListShardsResult.h.

◆ GetNextToken()

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

When the number of shards in 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 shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

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

Definition at line 109 of file ListShardsResult.h.

◆ GetShards()

const Aws::Vector<Shard>& Aws::Kinesis::Model::ListShardsResult::GetShards ( ) const
inline

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

Definition at line 43 of file ListShardsResult.h.

◆ operator=()

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

◆ SetNextToken() [1/3]

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

When the number of shards in 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 shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

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

Definition at line 143 of file ListShardsResult.h.

◆ SetNextToken() [2/3]

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

When the number of shards in 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 shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

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

Definition at line 126 of file ListShardsResult.h.

◆ SetNextToken() [3/3]

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

When the number of shards in 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 shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

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

Definition at line 160 of file ListShardsResult.h.

◆ SetShards() [1/2]

void Aws::Kinesis::Model::ListShardsResult::SetShards ( Aws::Vector< Shard > &&  value)
inline

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

Definition at line 59 of file ListShardsResult.h.

◆ SetShards() [2/2]

void Aws::Kinesis::Model::ListShardsResult::SetShards ( const Aws::Vector< Shard > &  value)
inline

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

Definition at line 51 of file ListShardsResult.h.

◆ WithNextToken() [1/3]

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

When the number of shards in 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 shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

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

Definition at line 194 of file ListShardsResult.h.

◆ WithNextToken() [2/3]

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

When the number of shards in 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 shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

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

Definition at line 177 of file ListShardsResult.h.

◆ WithNextToken() [3/3]

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

When the number of shards in 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 shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

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

Definition at line 211 of file ListShardsResult.h.

◆ WithShards() [1/2]

ListShardsResult& Aws::Kinesis::Model::ListShardsResult::WithShards ( Aws::Vector< Shard > &&  value)
inline

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

Definition at line 75 of file ListShardsResult.h.

◆ WithShards() [2/2]

ListShardsResult& Aws::Kinesis::Model::ListShardsResult::WithShards ( const Aws::Vector< Shard > &  value)
inline

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

Definition at line 67 of file ListShardsResult.h.


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