Aws::SQS::Model::StartMessageMoveTaskRequest Class Reference

#include <StartMessageMoveTaskRequest.h>

Inheritance diagram for Aws::SQS::Model::StartMessageMoveTaskRequest:

Public Member Functions

AWS_SQS_API StartMessageMoveTaskRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_SQS_API Aws::String SerializePayload () const override

 

AWS_SQS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override

 

const Aws::String & GetSourceArn () const

 

bool SourceArnHasBeenSet () const

 

template<typename SourceArnT = Aws::String>

void SetSourceArn (SourceArnT &&value)

 

template<typename SourceArnT = Aws::String>

StartMessageMoveTaskRequest & WithSourceArn (SourceArnT &&value)

 

const Aws::String & GetDestinationArn () const

 

bool DestinationArnHasBeenSet () const

 

template<typename DestinationArnT = Aws::String>

void SetDestinationArn (DestinationArnT &&value)

 

template<typename DestinationArnT = Aws::String>

StartMessageMoveTaskRequest & WithDestinationArn (DestinationArnT &&value)

 

int GetMaxNumberOfMessagesPerSecond () const

 

bool MaxNumberOfMessagesPerSecondHasBeenSet () const

 

void SetMaxNumberOfMessagesPerSecond (int value)

 

StartMessageMoveTaskRequest & WithMaxNumberOfMessagesPerSecond (int value)

 

Public Member Functions inherited from Aws::SQS::SQSRequest

virtual ~SQSRequest ()

 

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::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

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 HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual bool IsLongPollingOperation () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

RetryContext GetRetryContext () const

 

void SetRetryContext (const RetryContext &context) const

 

virtual Aws::Vector< smithy::AuthSchemeOption > GetRequestSpecificSupportedAuth () const

 

virtual bool ChecksumAlgorithmIsSet () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Additional Inherited Members

Public Types inherited from Aws::SQS::SQSRequest

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 19 of file StartMessageMoveTaskRequest.h.

Constructor & Destructor Documentation

StartMessageMoveTaskRequest()

AWS_SQS_API Aws::SQS::Model::StartMessageMoveTaskRequest::StartMessageMoveTaskRequest ( )

default

Member Function Documentation

DestinationArnHasBeenSet()

bool Aws::SQS::Model::StartMessageMoveTaskRequest::DestinationArnHasBeenSet ( ) const

inline

The ARN of the queue that receives the moved messages. You can use this field to specify the destination queue where you would like to redrive messages. If this field is left blank, the messages will be redriven back to their respective original source queues.

Definition at line 62 of file StartMessageMoveTaskRequest.h.

GetDestinationArn()

const Aws::String & Aws::SQS::Model::StartMessageMoveTaskRequest::GetDestinationArn ( ) const

inline

The ARN of the queue that receives the moved messages. You can use this field to specify the destination queue where you would like to redrive messages. If this field is left blank, the messages will be redriven back to their respective original source queues.

Definition at line 61 of file StartMessageMoveTaskRequest.h.

GetMaxNumberOfMessagesPerSecond()

int Aws::SQS::Model::StartMessageMoveTaskRequest::GetMaxNumberOfMessagesPerSecond ( ) const

inline

The number of messages to be moved per second (the message movement rate). You can use this field to define a fixed message movement rate. The maximum value for messages per second is 500. If this field is left blank, the system will optimize the rate based on the queue message backlog size, which may vary throughout the duration of the message movement task.

Definition at line 83 of file StartMessageMoveTaskRequest.h.

GetRequestSpecificHeaders()

AWS_SQS_API Aws::Http::HeaderValueCollection Aws::SQS::Model::StartMessageMoveTaskRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::SQS::SQSRequest.

GetServiceRequestName()

virtual const char * Aws::SQS::Model::StartMessageMoveTaskRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 27 of file StartMessageMoveTaskRequest.h.

GetSourceArn()

const Aws::String & Aws::SQS::Model::StartMessageMoveTaskRequest::GetSourceArn ( ) const

inline

The ARN of the queue that contains the messages to be moved to another queue. Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are not currently supported.

Definition at line 40 of file StartMessageMoveTaskRequest.h.

MaxNumberOfMessagesPerSecondHasBeenSet()

bool Aws::SQS::Model::StartMessageMoveTaskRequest::MaxNumberOfMessagesPerSecondHasBeenSet ( ) const

inline

The number of messages to be moved per second (the message movement rate). You can use this field to define a fixed message movement rate. The maximum value for messages per second is 500. If this field is left blank, the system will optimize the rate based on the queue message backlog size, which may vary throughout the duration of the message movement task.

Definition at line 84 of file StartMessageMoveTaskRequest.h.

SerializePayload()

AWS_SQS_API Aws::String Aws::SQS::Model::StartMessageMoveTaskRequest::SerializePayload ( ) const

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetDestinationArn()

template<typename DestinationArnT = Aws::String>

void Aws::SQS::Model::StartMessageMoveTaskRequest::SetDestinationArn ( DestinationArnT &&  value)

inline

The ARN of the queue that receives the moved messages. You can use this field to specify the destination queue where you would like to redrive messages. If this field is left blank, the messages will be redriven back to their respective original source queues.

Definition at line 64 of file StartMessageMoveTaskRequest.h.

SetMaxNumberOfMessagesPerSecond()

void Aws::SQS::Model::StartMessageMoveTaskRequest::SetMaxNumberOfMessagesPerSecond ( int  value)

inline

The number of messages to be moved per second (the message movement rate). You can use this field to define a fixed message movement rate. The maximum value for messages per second is 500. If this field is left blank, the system will optimize the rate based on the queue message backlog size, which may vary throughout the duration of the message movement task.

Definition at line 85 of file StartMessageMoveTaskRequest.h.

SetSourceArn()

template<typename SourceArnT = Aws::String>

void Aws::SQS::Model::StartMessageMoveTaskRequest::SetSourceArn ( SourceArnT &&  value)

inline

The ARN of the queue that contains the messages to be moved to another queue. Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are not currently supported.

Definition at line 43 of file StartMessageMoveTaskRequest.h.

SourceArnHasBeenSet()

bool Aws::SQS::Model::StartMessageMoveTaskRequest::SourceArnHasBeenSet ( ) const

inline

The ARN of the queue that contains the messages to be moved to another queue. Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are not currently supported.

Definition at line 41 of file StartMessageMoveTaskRequest.h.

WithDestinationArn()

template<typename DestinationArnT = Aws::String>

StartMessageMoveTaskRequest & Aws::SQS::Model::StartMessageMoveTaskRequest::WithDestinationArn ( DestinationArnT &&  value)

inline

The ARN of the queue that receives the moved messages. You can use this field to specify the destination queue where you would like to redrive messages. If this field is left blank, the messages will be redriven back to their respective original source queues.

Definition at line 69 of file StartMessageMoveTaskRequest.h.

WithMaxNumberOfMessagesPerSecond()

StartMessageMoveTaskRequest & Aws::SQS::Model::StartMessageMoveTaskRequest::WithMaxNumberOfMessagesPerSecond ( int  value)

inline

The number of messages to be moved per second (the message movement rate). You can use this field to define a fixed message movement rate. The maximum value for messages per second is 500. If this field is left blank, the system will optimize the rate based on the queue message backlog size, which may vary throughout the duration of the message movement task.

Definition at line 89 of file StartMessageMoveTaskRequest.h.

WithSourceArn()

template<typename SourceArnT = Aws::String>

StartMessageMoveTaskRequest & Aws::SQS::Model::StartMessageMoveTaskRequest::WithSourceArn ( SourceArnT &&  value)

inline

The ARN of the queue that contains the messages to be moved to another queue. Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are not currently supported.

Definition at line 48 of file StartMessageMoveTaskRequest.h.

---

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

• generated/src/aws-cpp-sdk-sqs/include/aws/sqs/model/StartMessageMoveTaskRequest.h