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

#include <SubscribeToShardRequest.h>

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

Public Member Functions

 SubscribeToShardRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
Aws::Utils::Event::EventStreamDecoderGetEventStreamDecoder ()
 
const SubscribeToShardHandlerGetEventStreamHandler () const
 
void SetEventStreamHandler (const SubscribeToShardHandler &value)
 
SubscribeToShardRequestWithEventStreamHandler (const SubscribeToShardHandler &value)
 
const Aws::StringGetConsumerARN () const
 
bool ConsumerARNHasBeenSet () const
 
void SetConsumerARN (const Aws::String &value)
 
void SetConsumerARN (Aws::String &&value)
 
void SetConsumerARN (const char *value)
 
SubscribeToShardRequestWithConsumerARN (const Aws::String &value)
 
SubscribeToShardRequestWithConsumerARN (Aws::String &&value)
 
SubscribeToShardRequestWithConsumerARN (const char *value)
 
const Aws::StringGetShardId () const
 
bool ShardIdHasBeenSet () const
 
void SetShardId (const Aws::String &value)
 
void SetShardId (Aws::String &&value)
 
void SetShardId (const char *value)
 
SubscribeToShardRequestWithShardId (const Aws::String &value)
 
SubscribeToShardRequestWithShardId (Aws::String &&value)
 
SubscribeToShardRequestWithShardId (const char *value)
 
const StartingPositionGetStartingPosition () const
 
bool StartingPositionHasBeenSet () const
 
void SetStartingPosition (const StartingPosition &value)
 
void SetStartingPosition (StartingPosition &&value)
 
SubscribeToShardRequestWithStartingPosition (const StartingPosition &value)
 
SubscribeToShardRequestWithStartingPosition (StartingPosition &&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 24 of file SubscribeToShardRequest.h.

Constructor & Destructor Documentation

◆ SubscribeToShardRequest()

Aws::Kinesis::Model::SubscribeToShardRequest::SubscribeToShardRequest ( )

Member Function Documentation

◆ ConsumerARNHasBeenSet()

bool Aws::Kinesis::Model::SubscribeToShardRequest::ConsumerARNHasBeenSet ( ) const
inline

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

Definition at line 70 of file SubscribeToShardRequest.h.

◆ GetConsumerARN()

const Aws::String& Aws::Kinesis::Model::SubscribeToShardRequest::GetConsumerARN ( ) const
inline

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

Definition at line 64 of file SubscribeToShardRequest.h.

◆ GetEventStreamDecoder()

Aws::Utils::Event::EventStreamDecoder& Aws::Kinesis::Model::SubscribeToShardRequest::GetEventStreamDecoder ( )
inline

Underlying Event Stream Decoder.

Definition at line 42 of file SubscribeToShardRequest.h.

◆ GetEventStreamHandler()

const SubscribeToShardHandler& Aws::Kinesis::Model::SubscribeToShardRequest::GetEventStreamHandler ( ) const
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 47 of file SubscribeToShardRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::Kinesis::KinesisRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file SubscribeToShardRequest.h.

◆ GetShardId()

const Aws::String& Aws::Kinesis::Model::SubscribeToShardRequest::GetShardId ( ) const
inline

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

Definition at line 113 of file SubscribeToShardRequest.h.

◆ GetStartingPosition()

const StartingPosition& Aws::Kinesis::Model::SubscribeToShardRequest::GetStartingPosition ( ) const
inline

Definition at line 159 of file SubscribeToShardRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetConsumerARN() [1/3]

void Aws::Kinesis::Model::SubscribeToShardRequest::SetConsumerARN ( const Aws::String value)
inline

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

Definition at line 76 of file SubscribeToShardRequest.h.

◆ SetConsumerARN() [2/3]

void Aws::Kinesis::Model::SubscribeToShardRequest::SetConsumerARN ( Aws::String &&  value)
inline

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

Definition at line 82 of file SubscribeToShardRequest.h.

◆ SetConsumerARN() [3/3]

void Aws::Kinesis::Model::SubscribeToShardRequest::SetConsumerARN ( const char *  value)
inline

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

Definition at line 88 of file SubscribeToShardRequest.h.

◆ SetEventStreamHandler()

void Aws::Kinesis::Model::SubscribeToShardRequest::SetEventStreamHandler ( const SubscribeToShardHandler value)
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 52 of file SubscribeToShardRequest.h.

◆ SetShardId() [1/3]

void Aws::Kinesis::Model::SubscribeToShardRequest::SetShardId ( const Aws::String value)
inline

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

Definition at line 125 of file SubscribeToShardRequest.h.

◆ SetShardId() [2/3]

void Aws::Kinesis::Model::SubscribeToShardRequest::SetShardId ( Aws::String &&  value)
inline

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

Definition at line 131 of file SubscribeToShardRequest.h.

◆ SetShardId() [3/3]

void Aws::Kinesis::Model::SubscribeToShardRequest::SetShardId ( const char *  value)
inline

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

Definition at line 137 of file SubscribeToShardRequest.h.

◆ SetStartingPosition() [1/2]

void Aws::Kinesis::Model::SubscribeToShardRequest::SetStartingPosition ( const StartingPosition value)
inline

Definition at line 165 of file SubscribeToShardRequest.h.

◆ SetStartingPosition() [2/2]

void Aws::Kinesis::Model::SubscribeToShardRequest::SetStartingPosition ( StartingPosition &&  value)
inline

Definition at line 168 of file SubscribeToShardRequest.h.

◆ ShardIdHasBeenSet()

bool Aws::Kinesis::Model::SubscribeToShardRequest::ShardIdHasBeenSet ( ) const
inline

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

Definition at line 119 of file SubscribeToShardRequest.h.

◆ StartingPositionHasBeenSet()

bool Aws::Kinesis::Model::SubscribeToShardRequest::StartingPositionHasBeenSet ( ) const
inline

Definition at line 162 of file SubscribeToShardRequest.h.

◆ WithConsumerARN() [1/3]

SubscribeToShardRequest& Aws::Kinesis::Model::SubscribeToShardRequest::WithConsumerARN ( const Aws::String value)
inline

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

Definition at line 94 of file SubscribeToShardRequest.h.

◆ WithConsumerARN() [2/3]

SubscribeToShardRequest& Aws::Kinesis::Model::SubscribeToShardRequest::WithConsumerARN ( Aws::String &&  value)
inline

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

Definition at line 100 of file SubscribeToShardRequest.h.

◆ WithConsumerARN() [3/3]

SubscribeToShardRequest& Aws::Kinesis::Model::SubscribeToShardRequest::WithConsumerARN ( const char *  value)
inline

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

Definition at line 106 of file SubscribeToShardRequest.h.

◆ WithEventStreamHandler()

SubscribeToShardRequest& Aws::Kinesis::Model::SubscribeToShardRequest::WithEventStreamHandler ( const SubscribeToShardHandler value)
inline

Underlying Event Stream Handler which is used to define callback functions.

Definition at line 57 of file SubscribeToShardRequest.h.

◆ WithShardId() [1/3]

SubscribeToShardRequest& Aws::Kinesis::Model::SubscribeToShardRequest::WithShardId ( const Aws::String value)
inline

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

Definition at line 143 of file SubscribeToShardRequest.h.

◆ WithShardId() [2/3]

SubscribeToShardRequest& Aws::Kinesis::Model::SubscribeToShardRequest::WithShardId ( Aws::String &&  value)
inline

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

Definition at line 149 of file SubscribeToShardRequest.h.

◆ WithShardId() [3/3]

SubscribeToShardRequest& Aws::Kinesis::Model::SubscribeToShardRequest::WithShardId ( const char *  value)
inline

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

Definition at line 155 of file SubscribeToShardRequest.h.

◆ WithStartingPosition() [1/2]

SubscribeToShardRequest& Aws::Kinesis::Model::SubscribeToShardRequest::WithStartingPosition ( const StartingPosition value)
inline

Definition at line 171 of file SubscribeToShardRequest.h.

◆ WithStartingPosition() [2/2]

SubscribeToShardRequest& Aws::Kinesis::Model::SubscribeToShardRequest::WithStartingPosition ( StartingPosition &&  value)
inline

Definition at line 174 of file SubscribeToShardRequest.h.


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