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

#include <ListStreamConsumersRequest.h>

+ Inheritance diagram for Aws::Kinesis::Model::ListStreamConsumersRequest:

Public Member Functions

 ListStreamConsumersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetStreamARN () const
 
bool StreamARNHasBeenSet () const
 
void SetStreamARN (const Aws::String &value)
 
void SetStreamARN (Aws::String &&value)
 
void SetStreamARN (const char *value)
 
ListStreamConsumersRequestWithStreamARN (const Aws::String &value)
 
ListStreamConsumersRequestWithStreamARN (Aws::String &&value)
 
ListStreamConsumersRequestWithStreamARN (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListStreamConsumersRequestWithNextToken (const Aws::String &value)
 
ListStreamConsumersRequestWithNextToken (Aws::String &&value)
 
ListStreamConsumersRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListStreamConsumersRequestWithMaxResults (int value)
 
const Aws::Utils::DateTimeGetStreamCreationTimestamp () const
 
bool StreamCreationTimestampHasBeenSet () const
 
void SetStreamCreationTimestamp (const Aws::Utils::DateTime &value)
 
void SetStreamCreationTimestamp (Aws::Utils::DateTime &&value)
 
ListStreamConsumersRequestWithStreamCreationTimestamp (const Aws::Utils::DateTime &value)
 
ListStreamConsumersRequestWithStreamCreationTimestamp (Aws::Utils::DateTime &&value)
 
- Public Member Functions inherited from Aws::Kinesis::KinesisRequest
virtual ~KinesisRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file ListStreamConsumersRequest.h.

Constructor & Destructor Documentation

◆ ListStreamConsumersRequest()

Aws::Kinesis::Model::ListStreamConsumersRequest::ListStreamConsumersRequest ( )

Member Function Documentation

◆ GetMaxResults()

int Aws::Kinesis::Model::ListStreamConsumersRequest::GetMaxResults ( ) const
inline

The maximum number of consumers that you want a single call of ListStreamConsumers to return.

Definition at line 308 of file ListStreamConsumersRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Kinesis::Model::ListStreamConsumersRequest::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 consumers that are registered with the data stream, 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.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers.

<important>

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.

</important>

Definition at line 126 of file ListStreamConsumersRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Kinesis::Model::ListStreamConsumersRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Kinesis::KinesisRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Kinesis::Model::ListStreamConsumersRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListStreamConsumersRequest.h.

◆ GetStreamARN()

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

The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 44 of file ListStreamConsumersRequest.h.

◆ GetStreamCreationTimestamp()

const Aws::Utils::DateTime& Aws::Kinesis::Model::ListStreamConsumersRequest::GetStreamCreationTimestamp ( ) const
inline

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.

You can't specify this parameter if you specify the NextToken parameter.

Definition at line 336 of file ListStreamConsumersRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Kinesis::Model::ListStreamConsumersRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of consumers that you want a single call of ListStreamConsumers to return.

Definition at line 314 of file ListStreamConsumersRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Kinesis::Model::ListStreamConsumersRequest::NextTokenHasBeenSet ( ) 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 consumers that are registered with the data stream, 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.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers.

<important>

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.

</important>

Definition at line 151 of file ListStreamConsumersRequest.h.

◆ SerializePayload()

Aws::String Aws::Kinesis::Model::ListStreamConsumersRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

void Aws::Kinesis::Model::ListStreamConsumersRequest::SetMaxResults ( int  value)
inline

The maximum number of consumers that you want a single call of ListStreamConsumers to return.

Definition at line 320 of file ListStreamConsumersRequest.h.

◆ SetNextToken() [1/3]

void Aws::Kinesis::Model::ListStreamConsumersRequest::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 consumers that are registered with the data stream, 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.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers.

<important>

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.

</important>

Definition at line 176 of file ListStreamConsumersRequest.h.

◆ SetNextToken() [2/3]

void Aws::Kinesis::Model::ListStreamConsumersRequest::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 consumers that are registered with the data stream, 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.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers.

<important>

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.

</important>

Definition at line 201 of file ListStreamConsumersRequest.h.

◆ SetNextToken() [3/3]

void Aws::Kinesis::Model::ListStreamConsumersRequest::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 consumers that are registered with the data stream, 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.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers.

<important>

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.

</important>

Definition at line 226 of file ListStreamConsumersRequest.h.

◆ SetStreamARN() [1/3]

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

The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 60 of file ListStreamConsumersRequest.h.

◆ SetStreamARN() [2/3]

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

The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 68 of file ListStreamConsumersRequest.h.

◆ SetStreamARN() [3/3]

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

The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 76 of file ListStreamConsumersRequest.h.

◆ SetStreamCreationTimestamp() [1/2]

void Aws::Kinesis::Model::ListStreamConsumersRequest::SetStreamCreationTimestamp ( const Aws::Utils::DateTime value)
inline

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.

You can't specify this parameter if you specify the NextToken parameter.

Definition at line 354 of file ListStreamConsumersRequest.h.

◆ SetStreamCreationTimestamp() [2/2]

void Aws::Kinesis::Model::ListStreamConsumersRequest::SetStreamCreationTimestamp ( Aws::Utils::DateTime &&  value)
inline

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.

You can't specify this parameter if you specify the NextToken parameter.

Definition at line 363 of file ListStreamConsumersRequest.h.

◆ StreamARNHasBeenSet()

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

The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 52 of file ListStreamConsumersRequest.h.

◆ StreamCreationTimestampHasBeenSet()

bool Aws::Kinesis::Model::ListStreamConsumersRequest::StreamCreationTimestampHasBeenSet ( ) const
inline

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.

You can't specify this parameter if you specify the NextToken parameter.

Definition at line 345 of file ListStreamConsumersRequest.h.

◆ WithMaxResults()

ListStreamConsumersRequest& Aws::Kinesis::Model::ListStreamConsumersRequest::WithMaxResults ( int  value)
inline

The maximum number of consumers that you want a single call of ListStreamConsumers to return.

Definition at line 326 of file ListStreamConsumersRequest.h.

◆ WithNextToken() [1/3]

ListStreamConsumersRequest& Aws::Kinesis::Model::ListStreamConsumersRequest::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 consumers that are registered with the data stream, 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.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers.

<important>

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.

</important>

Definition at line 251 of file ListStreamConsumersRequest.h.

◆ WithNextToken() [2/3]

ListStreamConsumersRequest& Aws::Kinesis::Model::ListStreamConsumersRequest::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 consumers that are registered with the data stream, 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.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers.

<important>

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.

</important>

Definition at line 276 of file ListStreamConsumersRequest.h.

◆ WithNextToken() [3/3]

ListStreamConsumersRequest& Aws::Kinesis::Model::ListStreamConsumersRequest::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 consumers that are registered with the data stream, 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.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers.

<important>

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.

</important>

Definition at line 301 of file ListStreamConsumersRequest.h.

◆ WithStreamARN() [1/3]

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

The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 84 of file ListStreamConsumersRequest.h.

◆ WithStreamARN() [2/3]

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

The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 92 of file ListStreamConsumersRequest.h.

◆ WithStreamARN() [3/3]

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

The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 100 of file ListStreamConsumersRequest.h.

◆ WithStreamCreationTimestamp() [1/2]

ListStreamConsumersRequest& Aws::Kinesis::Model::ListStreamConsumersRequest::WithStreamCreationTimestamp ( const Aws::Utils::DateTime value)
inline

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.

You can't specify this parameter if you specify the NextToken parameter.

Definition at line 372 of file ListStreamConsumersRequest.h.

◆ WithStreamCreationTimestamp() [2/2]

ListStreamConsumersRequest& Aws::Kinesis::Model::ListStreamConsumersRequest::WithStreamCreationTimestamp ( Aws::Utils::DateTime &&  value)
inline

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.

You can't specify this parameter if you specify the NextToken parameter.

Definition at line 381 of file ListStreamConsumersRequest.h.


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