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

Interface StartMessageMoveTaskRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartMessageMoveTaskRequest.Builder,StartMessageMoveTaskRequest>, SdkBuilder<StartMessageMoveTaskRequest.Builder,StartMessageMoveTaskRequest>, SdkPojo, SdkRequest.Builder, SqsRequest.Builder
Enclosing class:
StartMessageMoveTaskRequest
public static interface StartMessageMoveTaskRequest.Builder extends SqsRequest.Builder, SdkPojo, CopyableBuilder<StartMessageMoveTaskRequest.Builder,StartMessageMoveTaskRequest>

  • Method Details

    • sourceArn

      StartMessageMoveTaskRequest.Builder sourceArn(String sourceArn)

      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.

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

    • destinationArn

      StartMessageMoveTaskRequest.Builder destinationArn(String destinationArn)

      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.

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

    • maxNumberOfMessagesPerSecond

      StartMessageMoveTaskRequest.Builder maxNumberOfMessagesPerSecond(Integer maxNumberOfMessagesPerSecond)

      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.

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

    • overrideConfiguration

      StartMessageMoveTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartMessageMoveTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.