/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace SQS { namespace Model { /** *

Contains the details of a message movement task.

See Also:

* AWS * API Reference

*/ class ListMessageMoveTasksResultEntry { public: AWS_SQS_API ListMessageMoveTasksResultEntry(); AWS_SQS_API ListMessageMoveTasksResultEntry(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_SQS_API ListMessageMoveTasksResultEntry& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_SQS_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; AWS_SQS_API void OutputToStream(Aws::OStream& oStream, const char* location) const; /** *

An identifier associated with a message movement task. When this field is * returned in the response of the ListMessageMoveTasks action, it is * only populated for tasks that are in RUNNING status.

*/ inline const Aws::String& GetTaskHandle() const{ return m_taskHandle; } /** *

An identifier associated with a message movement task. When this field is * returned in the response of the ListMessageMoveTasks action, it is * only populated for tasks that are in RUNNING status.

*/ inline bool TaskHandleHasBeenSet() const { return m_taskHandleHasBeenSet; } /** *

An identifier associated with a message movement task. When this field is * returned in the response of the ListMessageMoveTasks action, it is * only populated for tasks that are in RUNNING status.

*/ inline void SetTaskHandle(const Aws::String& value) { m_taskHandleHasBeenSet = true; m_taskHandle = value; } /** *

An identifier associated with a message movement task. When this field is * returned in the response of the ListMessageMoveTasks action, it is * only populated for tasks that are in RUNNING status.

*/ inline void SetTaskHandle(Aws::String&& value) { m_taskHandleHasBeenSet = true; m_taskHandle = std::move(value); } /** *

An identifier associated with a message movement task. When this field is * returned in the response of the ListMessageMoveTasks action, it is * only populated for tasks that are in RUNNING status.

*/ inline void SetTaskHandle(const char* value) { m_taskHandleHasBeenSet = true; m_taskHandle.assign(value); } /** *

An identifier associated with a message movement task. When this field is * returned in the response of the ListMessageMoveTasks action, it is * only populated for tasks that are in RUNNING status.

*/ inline ListMessageMoveTasksResultEntry& WithTaskHandle(const Aws::String& value) { SetTaskHandle(value); return *this;} /** *

An identifier associated with a message movement task. When this field is * returned in the response of the ListMessageMoveTasks action, it is * only populated for tasks that are in RUNNING status.

*/ inline ListMessageMoveTasksResultEntry& WithTaskHandle(Aws::String&& value) { SetTaskHandle(std::move(value)); return *this;} /** *

An identifier associated with a message movement task. When this field is * returned in the response of the ListMessageMoveTasks action, it is * only populated for tasks that are in RUNNING status.

*/ inline ListMessageMoveTasksResultEntry& WithTaskHandle(const char* value) { SetTaskHandle(value); return *this;} /** *

The status of the message movement task. Possible values are: RUNNING, * COMPLETED, CANCELLING, CANCELLED, and FAILED.

*/ inline const Aws::String& GetStatus() const{ return m_status; } /** *

The status of the message movement task. Possible values are: RUNNING, * COMPLETED, CANCELLING, CANCELLED, and FAILED.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The status of the message movement task. Possible values are: RUNNING, * COMPLETED, CANCELLING, CANCELLED, and FAILED.

*/ inline void SetStatus(const Aws::String& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The status of the message movement task. Possible values are: RUNNING, * COMPLETED, CANCELLING, CANCELLED, and FAILED.

*/ inline void SetStatus(Aws::String&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The status of the message movement task. Possible values are: RUNNING, * COMPLETED, CANCELLING, CANCELLED, and FAILED.

*/ inline void SetStatus(const char* value) { m_statusHasBeenSet = true; m_status.assign(value); } /** *

The status of the message movement task. Possible values are: RUNNING, * COMPLETED, CANCELLING, CANCELLED, and FAILED.

*/ inline ListMessageMoveTasksResultEntry& WithStatus(const Aws::String& value) { SetStatus(value); return *this;} /** *

The status of the message movement task. Possible values are: RUNNING, * COMPLETED, CANCELLING, CANCELLED, and FAILED.

*/ inline ListMessageMoveTasksResultEntry& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); return *this;} /** *

The status of the message movement task. Possible values are: RUNNING, * COMPLETED, CANCELLING, CANCELLED, and FAILED.

*/ inline ListMessageMoveTasksResultEntry& WithStatus(const char* value) { SetStatus(value); return *this;} /** *

The ARN of the queue that contains the messages to be moved to another * queue.

*/ inline const Aws::String& GetSourceArn() const{ return m_sourceArn; } /** *

The ARN of the queue that contains the messages to be moved to another * queue.

*/ inline bool SourceArnHasBeenSet() const { return m_sourceArnHasBeenSet; } /** *

The ARN of the queue that contains the messages to be moved to another * queue.

*/ inline void SetSourceArn(const Aws::String& value) { m_sourceArnHasBeenSet = true; m_sourceArn = value; } /** *

The ARN of the queue that contains the messages to be moved to another * queue.

*/ inline void SetSourceArn(Aws::String&& value) { m_sourceArnHasBeenSet = true; m_sourceArn = std::move(value); } /** *

The ARN of the queue that contains the messages to be moved to another * queue.

*/ inline void SetSourceArn(const char* value) { m_sourceArnHasBeenSet = true; m_sourceArn.assign(value); } /** *

The ARN of the queue that contains the messages to be moved to another * queue.

*/ inline ListMessageMoveTasksResultEntry& WithSourceArn(const Aws::String& value) { SetSourceArn(value); return *this;} /** *

The ARN of the queue that contains the messages to be moved to another * queue.

*/ inline ListMessageMoveTasksResultEntry& WithSourceArn(Aws::String&& value) { SetSourceArn(std::move(value)); return *this;} /** *

The ARN of the queue that contains the messages to be moved to another * queue.

*/ inline ListMessageMoveTasksResultEntry& WithSourceArn(const char* value) { SetSourceArn(value); return *this;} /** *

The ARN of the destination queue if it has been specified in the * StartMessageMoveTask request. If a DestinationArn has * not been specified in the StartMessageMoveTask request, this field * value will be NULL.

*/ inline const Aws::String& GetDestinationArn() const{ return m_destinationArn; } /** *

The ARN of the destination queue if it has been specified in the * StartMessageMoveTask request. If a DestinationArn has * not been specified in the StartMessageMoveTask request, this field * value will be NULL.

*/ inline bool DestinationArnHasBeenSet() const { return m_destinationArnHasBeenSet; } /** *

The ARN of the destination queue if it has been specified in the * StartMessageMoveTask request. If a DestinationArn has * not been specified in the StartMessageMoveTask request, this field * value will be NULL.

*/ inline void SetDestinationArn(const Aws::String& value) { m_destinationArnHasBeenSet = true; m_destinationArn = value; } /** *

The ARN of the destination queue if it has been specified in the * StartMessageMoveTask request. If a DestinationArn has * not been specified in the StartMessageMoveTask request, this field * value will be NULL.

*/ inline void SetDestinationArn(Aws::String&& value) { m_destinationArnHasBeenSet = true; m_destinationArn = std::move(value); } /** *

The ARN of the destination queue if it has been specified in the * StartMessageMoveTask request. If a DestinationArn has * not been specified in the StartMessageMoveTask request, this field * value will be NULL.

*/ inline void SetDestinationArn(const char* value) { m_destinationArnHasBeenSet = true; m_destinationArn.assign(value); } /** *

The ARN of the destination queue if it has been specified in the * StartMessageMoveTask request. If a DestinationArn has * not been specified in the StartMessageMoveTask request, this field * value will be NULL.

*/ inline ListMessageMoveTasksResultEntry& WithDestinationArn(const Aws::String& value) { SetDestinationArn(value); return *this;} /** *

The ARN of the destination queue if it has been specified in the * StartMessageMoveTask request. If a DestinationArn has * not been specified in the StartMessageMoveTask request, this field * value will be NULL.

*/ inline ListMessageMoveTasksResultEntry& WithDestinationArn(Aws::String&& value) { SetDestinationArn(std::move(value)); return *this;} /** *

The ARN of the destination queue if it has been specified in the * StartMessageMoveTask request. If a DestinationArn has * not been specified in the StartMessageMoveTask request, this field * value will be NULL.

*/ inline ListMessageMoveTasksResultEntry& WithDestinationArn(const char* value) { SetDestinationArn(value); return *this;} /** *

The number of messages to be moved per second (the message movement rate), if * it has been specified in the StartMessageMoveTask request. If a * MaxNumberOfMessagesPerSecond has not been specified in the * StartMessageMoveTask request, this field value will be NULL.

*/ inline int GetMaxNumberOfMessagesPerSecond() const{ return m_maxNumberOfMessagesPerSecond; } /** *

The number of messages to be moved per second (the message movement rate), if * it has been specified in the StartMessageMoveTask request. If a * MaxNumberOfMessagesPerSecond has not been specified in the * StartMessageMoveTask request, this field value will be NULL.

*/ inline bool MaxNumberOfMessagesPerSecondHasBeenSet() const { return m_maxNumberOfMessagesPerSecondHasBeenSet; } /** *

The number of messages to be moved per second (the message movement rate), if * it has been specified in the StartMessageMoveTask request. If a * MaxNumberOfMessagesPerSecond has not been specified in the * StartMessageMoveTask request, this field value will be NULL.

*/ inline void SetMaxNumberOfMessagesPerSecond(int value) { m_maxNumberOfMessagesPerSecondHasBeenSet = true; m_maxNumberOfMessagesPerSecond = value; } /** *

The number of messages to be moved per second (the message movement rate), if * it has been specified in the StartMessageMoveTask request. If a * MaxNumberOfMessagesPerSecond has not been specified in the * StartMessageMoveTask request, this field value will be NULL.

*/ inline ListMessageMoveTasksResultEntry& WithMaxNumberOfMessagesPerSecond(int value) { SetMaxNumberOfMessagesPerSecond(value); return *this;} /** *

The approximate number of messages already moved to the destination * queue.

*/ inline long long GetApproximateNumberOfMessagesMoved() const{ return m_approximateNumberOfMessagesMoved; } /** *

The approximate number of messages already moved to the destination * queue.

*/ inline bool ApproximateNumberOfMessagesMovedHasBeenSet() const { return m_approximateNumberOfMessagesMovedHasBeenSet; } /** *

The approximate number of messages already moved to the destination * queue.

*/ inline void SetApproximateNumberOfMessagesMoved(long long value) { m_approximateNumberOfMessagesMovedHasBeenSet = true; m_approximateNumberOfMessagesMoved = value; } /** *

The approximate number of messages already moved to the destination * queue.

*/ inline ListMessageMoveTasksResultEntry& WithApproximateNumberOfMessagesMoved(long long value) { SetApproximateNumberOfMessagesMoved(value); return *this;} /** *

The number of messages to be moved from the source queue. This number is * obtained at the time of starting the message movement task.

*/ inline long long GetApproximateNumberOfMessagesToMove() const{ return m_approximateNumberOfMessagesToMove; } /** *

The number of messages to be moved from the source queue. This number is * obtained at the time of starting the message movement task.

*/ inline bool ApproximateNumberOfMessagesToMoveHasBeenSet() const { return m_approximateNumberOfMessagesToMoveHasBeenSet; } /** *

The number of messages to be moved from the source queue. This number is * obtained at the time of starting the message movement task.

*/ inline void SetApproximateNumberOfMessagesToMove(long long value) { m_approximateNumberOfMessagesToMoveHasBeenSet = true; m_approximateNumberOfMessagesToMove = value; } /** *

The number of messages to be moved from the source queue. This number is * obtained at the time of starting the message movement task.

*/ inline ListMessageMoveTasksResultEntry& WithApproximateNumberOfMessagesToMove(long long value) { SetApproximateNumberOfMessagesToMove(value); return *this;} /** *

The task failure reason (only included if the task status is FAILED).

*/ inline const Aws::String& GetFailureReason() const{ return m_failureReason; } /** *

The task failure reason (only included if the task status is FAILED).

*/ inline bool FailureReasonHasBeenSet() const { return m_failureReasonHasBeenSet; } /** *

The task failure reason (only included if the task status is FAILED).

*/ inline void SetFailureReason(const Aws::String& value) { m_failureReasonHasBeenSet = true; m_failureReason = value; } /** *

The task failure reason (only included if the task status is FAILED).

*/ inline void SetFailureReason(Aws::String&& value) { m_failureReasonHasBeenSet = true; m_failureReason = std::move(value); } /** *

The task failure reason (only included if the task status is FAILED).

*/ inline void SetFailureReason(const char* value) { m_failureReasonHasBeenSet = true; m_failureReason.assign(value); } /** *

The task failure reason (only included if the task status is FAILED).

*/ inline ListMessageMoveTasksResultEntry& WithFailureReason(const Aws::String& value) { SetFailureReason(value); return *this;} /** *

The task failure reason (only included if the task status is FAILED).

*/ inline ListMessageMoveTasksResultEntry& WithFailureReason(Aws::String&& value) { SetFailureReason(std::move(value)); return *this;} /** *

The task failure reason (only included if the task status is FAILED).

*/ inline ListMessageMoveTasksResultEntry& WithFailureReason(const char* value) { SetFailureReason(value); return *this;} /** *

The timestamp of starting the message movement task.

*/ inline long long GetStartedTimestamp() const{ return m_startedTimestamp; } /** *

The timestamp of starting the message movement task.

*/ inline bool StartedTimestampHasBeenSet() const { return m_startedTimestampHasBeenSet; } /** *

The timestamp of starting the message movement task.

*/ inline void SetStartedTimestamp(long long value) { m_startedTimestampHasBeenSet = true; m_startedTimestamp = value; } /** *

The timestamp of starting the message movement task.

*/ inline ListMessageMoveTasksResultEntry& WithStartedTimestamp(long long value) { SetStartedTimestamp(value); return *this;} private: Aws::String m_taskHandle; bool m_taskHandleHasBeenSet = false; Aws::String m_status; bool m_statusHasBeenSet = false; Aws::String m_sourceArn; bool m_sourceArnHasBeenSet = false; Aws::String m_destinationArn; bool m_destinationArnHasBeenSet = false; int m_maxNumberOfMessagesPerSecond; bool m_maxNumberOfMessagesPerSecondHasBeenSet = false; long long m_approximateNumberOfMessagesMoved; bool m_approximateNumberOfMessagesMovedHasBeenSet = false; long long m_approximateNumberOfMessagesToMove; bool m_approximateNumberOfMessagesToMoveHasBeenSet = false; Aws::String m_failureReason; bool m_failureReasonHasBeenSet = false; long long m_startedTimestamp; bool m_startedTimestampHasBeenSet = false; }; } // namespace Model } // namespace SQS } // namespace Aws