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

#include <DescribeStreamRequest.h>

+ Inheritance diagram for Aws::Kinesis::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::StringGetStreamName () const
 
bool StreamNameHasBeenSet () const
 
void SetStreamName (const Aws::String &value)
 
void SetStreamName (Aws::String &&value)
 
void SetStreamName (const char *value)
 
DescribeStreamRequestWithStreamName (const Aws::String &value)
 
DescribeStreamRequestWithStreamName (Aws::String &&value)
 
DescribeStreamRequestWithStreamName (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::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

Represents the input for DescribeStream.

See Also:

AWS API Reference

Definition at line 25 of file DescribeStreamRequest.h.

Constructor & Destructor Documentation

◆ DescribeStreamRequest()

Aws::Kinesis::Model::DescribeStreamRequest::DescribeStreamRequest ( )

Member Function Documentation

◆ ExclusiveStartShardIdHasBeenSet()

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

The shard ID of the shard to start with.

Definition at line 119 of file DescribeStreamRequest.h.

◆ GetExclusiveStartShardId()

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

The shard ID of the shard to start with.

Definition at line 114 of file DescribeStreamRequest.h.

◆ GetLimit()

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

The maximum number of shards to return in a single call. The default value is

  1. If you specify a value greater than 100, at most 100 shards are returned.

Definition at line 87 of file DescribeStreamRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::Kinesis::KinesisRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeStreamRequest.h.

◆ GetStreamName()

const Aws::String& Aws::Kinesis::Model::DescribeStreamRequest::GetStreamName ( ) const
inline

The name of the stream to describe.

Definition at line 44 of file DescribeStreamRequest.h.

◆ LimitHasBeenSet()

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

The maximum number of shards to return in a single call. The default value is

  1. If you specify a value greater than 100, at most 100 shards are returned.

Definition at line 94 of file DescribeStreamRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExclusiveStartShardId() [1/3]

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

The shard ID of the shard to start with.

Definition at line 124 of file DescribeStreamRequest.h.

◆ SetExclusiveStartShardId() [2/3]

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

The shard ID of the shard to start with.

Definition at line 129 of file DescribeStreamRequest.h.

◆ SetExclusiveStartShardId() [3/3]

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

The shard ID of the shard to start with.

Definition at line 134 of file DescribeStreamRequest.h.

◆ SetLimit()

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

The maximum number of shards to return in a single call. The default value is

  1. If you specify a value greater than 100, at most 100 shards are returned.

Definition at line 101 of file DescribeStreamRequest.h.

◆ SetStreamName() [1/3]

void Aws::Kinesis::Model::DescribeStreamRequest::SetStreamName ( const Aws::String value)
inline

The name of the stream to describe.

Definition at line 54 of file DescribeStreamRequest.h.

◆ SetStreamName() [2/3]

void Aws::Kinesis::Model::DescribeStreamRequest::SetStreamName ( Aws::String &&  value)
inline

The name of the stream to describe.

Definition at line 59 of file DescribeStreamRequest.h.

◆ SetStreamName() [3/3]

void Aws::Kinesis::Model::DescribeStreamRequest::SetStreamName ( const char *  value)
inline

The name of the stream to describe.

Definition at line 64 of file DescribeStreamRequest.h.

◆ StreamNameHasBeenSet()

bool Aws::Kinesis::Model::DescribeStreamRequest::StreamNameHasBeenSet ( ) const
inline

The name of the stream to describe.

Definition at line 49 of file DescribeStreamRequest.h.

◆ WithExclusiveStartShardId() [1/3]

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

The shard ID of the shard to start with.

Definition at line 139 of file DescribeStreamRequest.h.

◆ WithExclusiveStartShardId() [2/3]

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

The shard ID of the shard to start with.

Definition at line 144 of file DescribeStreamRequest.h.

◆ WithExclusiveStartShardId() [3/3]

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

The shard ID of the shard to start with.

Definition at line 149 of file DescribeStreamRequest.h.

◆ WithLimit()

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

The maximum number of shards to return in a single call. The default value is

  1. If you specify a value greater than 100, at most 100 shards are returned.

Definition at line 108 of file DescribeStreamRequest.h.

◆ WithStreamName() [1/3]

DescribeStreamRequest& Aws::Kinesis::Model::DescribeStreamRequest::WithStreamName ( const Aws::String value)
inline

The name of the stream to describe.

Definition at line 69 of file DescribeStreamRequest.h.

◆ WithStreamName() [2/3]

DescribeStreamRequest& Aws::Kinesis::Model::DescribeStreamRequest::WithStreamName ( Aws::String &&  value)
inline

The name of the stream to describe.

Definition at line 74 of file DescribeStreamRequest.h.

◆ WithStreamName() [3/3]

DescribeStreamRequest& Aws::Kinesis::Model::DescribeStreamRequest::WithStreamName ( const char *  value)
inline

The name of the stream to describe.

Definition at line 79 of file DescribeStreamRequest.h.


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