AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::DynamoDBStreams::Model::DescribeStreamRequest Class Reference

#include <DescribeStreamRequest.h>

+ Inheritance diagram for Aws::DynamoDBStreams::Model::DescribeStreamRequest:

Public Member Functions

 DescribeStreamRequest ()
 
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)
 
DescribeStreamRequestWithStreamArn (const Aws::String &value)
 
DescribeStreamRequestWithStreamArn (Aws::String &&value)
 
DescribeStreamRequestWithStreamArn (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeStreamRequestWithLimit (int value)
 
const Aws::StringGetExclusiveStartShardId () const
 
bool ExclusiveStartShardIdHasBeenSet () const
 
void SetExclusiveStartShardId (const Aws::String &value)
 
void SetExclusiveStartShardId (Aws::String &&value)
 
void SetExclusiveStartShardId (const char *value)
 
DescribeStreamRequestWithExclusiveStartShardId (const Aws::String &value)
 
DescribeStreamRequestWithExclusiveStartShardId (Aws::String &&value)
 
DescribeStreamRequestWithExclusiveStartShardId (const char *value)
 
- Public Member Functions inherited from Aws::DynamoDBStreams::DynamoDBStreamsRequest
virtual ~DynamoDBStreamsRequest ()
 
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

Represents the input of a DescribeStream operation.

See Also:

AWS API Reference

Definition at line 25 of file DescribeStreamRequest.h.

Constructor & Destructor Documentation

◆ DescribeStreamRequest()

Aws::DynamoDBStreams::Model::DescribeStreamRequest::DescribeStreamRequest ( )

Member Function Documentation

◆ ExclusiveStartShardIdHasBeenSet()

bool Aws::DynamoDBStreams::Model::DescribeStreamRequest::ExclusiveStartShardIdHasBeenSet ( ) const
inline

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Definition at line 115 of file DescribeStreamRequest.h.

◆ GetExclusiveStartShardId()

const Aws::String& Aws::DynamoDBStreams::Model::DescribeStreamRequest::GetExclusiveStartShardId ( ) const
inline

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Definition at line 108 of file DescribeStreamRequest.h.

◆ GetLimit()

int Aws::DynamoDBStreams::Model::DescribeStreamRequest::GetLimit ( ) const
inline

The maximum number of shard objects to return. The upper limit is 100.

Definition at line 85 of file DescribeStreamRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DynamoDBStreams::Model::DescribeStreamRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::DynamoDBStreams::Model::DescribeStreamRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeStreamRequest.h.

◆ GetStreamArn()

const Aws::String& Aws::DynamoDBStreams::Model::DescribeStreamRequest::GetStreamArn ( ) const
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 44 of file DescribeStreamRequest.h.

◆ LimitHasBeenSet()

bool Aws::DynamoDBStreams::Model::DescribeStreamRequest::LimitHasBeenSet ( ) const
inline

The maximum number of shard objects to return. The upper limit is 100.

Definition at line 90 of file DescribeStreamRequest.h.

◆ SerializePayload()

Aws::String Aws::DynamoDBStreams::Model::DescribeStreamRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExclusiveStartShardId() [1/3]

void Aws::DynamoDBStreams::Model::DescribeStreamRequest::SetExclusiveStartShardId ( const Aws::String value)
inline

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Definition at line 122 of file DescribeStreamRequest.h.

◆ SetExclusiveStartShardId() [2/3]

void Aws::DynamoDBStreams::Model::DescribeStreamRequest::SetExclusiveStartShardId ( Aws::String &&  value)
inline

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Definition at line 129 of file DescribeStreamRequest.h.

◆ SetExclusiveStartShardId() [3/3]

void Aws::DynamoDBStreams::Model::DescribeStreamRequest::SetExclusiveStartShardId ( const char *  value)
inline

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Definition at line 136 of file DescribeStreamRequest.h.

◆ SetLimit()

void Aws::DynamoDBStreams::Model::DescribeStreamRequest::SetLimit ( int  value)
inline

The maximum number of shard objects to return. The upper limit is 100.

Definition at line 95 of file DescribeStreamRequest.h.

◆ SetStreamArn() [1/3]

void Aws::DynamoDBStreams::Model::DescribeStreamRequest::SetStreamArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 54 of file DescribeStreamRequest.h.

◆ SetStreamArn() [2/3]

void Aws::DynamoDBStreams::Model::DescribeStreamRequest::SetStreamArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 59 of file DescribeStreamRequest.h.

◆ SetStreamArn() [3/3]

void Aws::DynamoDBStreams::Model::DescribeStreamRequest::SetStreamArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 64 of file DescribeStreamRequest.h.

◆ StreamArnHasBeenSet()

bool Aws::DynamoDBStreams::Model::DescribeStreamRequest::StreamArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 49 of file DescribeStreamRequest.h.

◆ WithExclusiveStartShardId() [1/3]

DescribeStreamRequest& Aws::DynamoDBStreams::Model::DescribeStreamRequest::WithExclusiveStartShardId ( const Aws::String value)
inline

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Definition at line 143 of file DescribeStreamRequest.h.

◆ WithExclusiveStartShardId() [2/3]

DescribeStreamRequest& Aws::DynamoDBStreams::Model::DescribeStreamRequest::WithExclusiveStartShardId ( Aws::String &&  value)
inline

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Definition at line 150 of file DescribeStreamRequest.h.

◆ WithExclusiveStartShardId() [3/3]

DescribeStreamRequest& Aws::DynamoDBStreams::Model::DescribeStreamRequest::WithExclusiveStartShardId ( const char *  value)
inline

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

Definition at line 157 of file DescribeStreamRequest.h.

◆ WithLimit()

DescribeStreamRequest& Aws::DynamoDBStreams::Model::DescribeStreamRequest::WithLimit ( int  value)
inline

The maximum number of shard objects to return. The upper limit is 100.

Definition at line 100 of file DescribeStreamRequest.h.

◆ WithStreamArn() [1/3]

DescribeStreamRequest& Aws::DynamoDBStreams::Model::DescribeStreamRequest::WithStreamArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 69 of file DescribeStreamRequest.h.

◆ WithStreamArn() [2/3]

DescribeStreamRequest& Aws::DynamoDBStreams::Model::DescribeStreamRequest::WithStreamArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 74 of file DescribeStreamRequest.h.

◆ WithStreamArn() [3/3]

DescribeStreamRequest& Aws::DynamoDBStreams::Model::DescribeStreamRequest::WithStreamArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the stream.

Definition at line 79 of file DescribeStreamRequest.h.


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