Class ListMessageMoveTasksResultEntry

java.lang.Object
software.amazon.awssdk.services.sqs.model.ListMessageMoveTasksResultEntry
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ListMessageMoveTasksResultEntry.Builder,ListMessageMoveTasksResultEntry>
@Generated("software.amazon.awssdk:codegen") public final class ListMessageMoveTasksResultEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ListMessageMoveTasksResultEntry.Builder,ListMessageMoveTasksResultEntry>

Contains the details of a message movement task.

See Also:

  • Method Details

    • taskHandle

      public final 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.

      Returns:
      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.

    • status

      public final String status()

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

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

    • sourceArn

      public final String sourceArn()

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

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

    • destinationArn

      public final 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.

      Returns:
      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.

    • maxNumberOfMessagesPerSecond

      public final 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.

      Returns:
      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.

    • approximateNumberOfMessagesMoved

      public final Long approximateNumberOfMessagesMoved()

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

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

    • approximateNumberOfMessagesToMove

      public final 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 and is only included after the message movement task is selected to start.

      Returns:
      The number of messages to be moved from the source queue. This number is obtained at the time of starting the message movement task and is only included after the message movement task is selected to start.

    • failureReason

      public final String failureReason()

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

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

    • startedTimestamp

      public final Long startedTimestamp()

      The timestamp of starting the message movement task.

      Returns:
      The timestamp of starting the message movement task.

    • toBuilder

      public ListMessageMoveTasksResultEntry.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListMessageMoveTasksResultEntry.Builder,ListMessageMoveTasksResultEntry>
      Returns:
      a builder for type T

    • builder

      public static ListMessageMoveTasksResultEntry.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListMessageMoveTasksResultEntry.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.