Package software.amazon.awssdk.services.sqs.model

Interface ListMessageMoveTasksResultEntry.Builder

    • Method Detail

      • taskHandle

        ListMessageMoveTasksResultEntry.Builder taskHandle​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ListMessageMoveTasksResultEntry.Builder status​(String status)

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

        Parameters:
        status - The status of the message movement task. Possible values are: RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TaskStatus, TaskStatus

      • status

        ListMessageMoveTasksResultEntry.Builder status​(TaskStatus status)

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

        Parameters:
        status - The status of the message movement task. Possible values are: RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TaskStatus, TaskStatus

      • sourceArn

        ListMessageMoveTasksResultEntry.Builder sourceArn​(String sourceArn)

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

        Parameters:
        sourceArn - The ARN of the queue that contains the messages to be moved to another queue.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinationArn

        ListMessageMoveTasksResultEntry.Builder destinationArn​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxNumberOfMessagesPerSecond

        ListMessageMoveTasksResultEntry.Builder maxNumberOfMessagesPerSecond​(Integer 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • approximateNumberOfMessagesMoved

        ListMessageMoveTasksResultEntry.Builder approximateNumberOfMessagesMoved​(Long approximateNumberOfMessagesMoved)

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

        Parameters:
        approximateNumberOfMessagesMoved - The approximate number of messages already moved to the destination queue.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • approximateNumberOfMessagesToMove

        ListMessageMoveTasksResultEntry.Builder approximateNumberOfMessagesToMove​(Long 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureReason

        ListMessageMoveTasksResultEntry.Builder failureReason​(String failureReason)

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

        Parameters:
        failureReason - The task failure reason (only included if the task status is FAILED).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startedTimestamp

        ListMessageMoveTasksResultEntry.Builder startedTimestamp​(Long startedTimestamp)

        The timestamp of starting the message movement task.

        Parameters:
        startedTimestamp - The timestamp of starting the message movement task.
        Returns:
        Returns a reference to this object so that method calls can be chained together.