Interface UpdateQueueRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateQueueRequest.Builder,UpdateQueueRequest>, DeadlineRequest.Builder, SdkBuilder<UpdateQueueRequest.Builder,UpdateQueueRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateQueueRequest
@Mutable @NotThreadSafe public static interface UpdateQueueRequest.Builder extends DeadlineRequest.Builder, SdkPojo, CopyableBuilder<UpdateQueueRequest.Builder,UpdateQueueRequest>

  • Method Details

    • farmId

      UpdateQueueRequest.Builder farmId(String farmId)

      The farm ID to update in the queue.

      Parameters:
      farmId - The farm ID to update in the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queueId

      UpdateQueueRequest.Builder queueId(String queueId)

      The queue ID to update.

      Parameters:
      queueId - The queue ID to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      UpdateQueueRequest.Builder clientToken(String clientToken)

      The idempotency token to update in the queue.

      Parameters:
      clientToken - The idempotency token to update in the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      UpdateQueueRequest.Builder displayName(String displayName)

      The display name of the queue to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Parameters:
      displayName - The display name of the queue to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateQueueRequest.Builder description(String description)

      The description of the queue to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Parameters:
      description - The description of the queue to update.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultBudgetAction

      UpdateQueueRequest.Builder defaultBudgetAction(String defaultBudgetAction)

      The default action to take for a queue update if a budget isn't configured.

      Parameters:
      defaultBudgetAction - The default action to take for a queue update if a budget isn't configured.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaultBudgetAction

      UpdateQueueRequest.Builder defaultBudgetAction(DefaultQueueBudgetAction defaultBudgetAction)

      The default action to take for a queue update if a budget isn't configured.

      Parameters:
      defaultBudgetAction - The default action to take for a queue update if a budget isn't configured.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobAttachmentSettings

      UpdateQueueRequest.Builder jobAttachmentSettings(JobAttachmentSettings jobAttachmentSettings)

      The job attachment settings to update for the queue.

      Parameters:
      jobAttachmentSettings - The job attachment settings to update for the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobAttachmentSettings

      default UpdateQueueRequest.Builder jobAttachmentSettings(Consumer<JobAttachmentSettings.Builder> jobAttachmentSettings)

      The job attachment settings to update for the queue.

      This is a convenience method that creates an instance of the JobAttachmentSettings.Builder avoiding the need to create one manually via JobAttachmentSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobAttachmentSettings(JobAttachmentSettings).

      Parameters:
      jobAttachmentSettings - a consumer that will call methods on JobAttachmentSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      UpdateQueueRequest.Builder roleArn(String roleArn)

      The IAM role ARN that's used to run jobs from this queue.

      Parameters:
      roleArn - The IAM role ARN that's used to run jobs from this queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobRunAsUser

      UpdateQueueRequest.Builder jobRunAsUser(JobRunAsUser jobRunAsUser)

      Update the jobs in the queue to run as a specified POSIX user.

      Parameters:
      jobRunAsUser - Update the jobs in the queue to run as a specified POSIX user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobRunAsUser

      default UpdateQueueRequest.Builder jobRunAsUser(Consumer<JobRunAsUser.Builder> jobRunAsUser)

      Update the jobs in the queue to run as a specified POSIX user.

      This is a convenience method that creates an instance of the JobRunAsUser.Builder avoiding the need to create one manually via JobRunAsUser.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobRunAsUser(JobRunAsUser).

      Parameters:
      jobRunAsUser - a consumer that will call methods on JobRunAsUser.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requiredFileSystemLocationNamesToAdd

      UpdateQueueRequest.Builder requiredFileSystemLocationNamesToAdd(Collection<String> requiredFileSystemLocationNamesToAdd)

      The required file system location names to add to the queue.

      Parameters:
      requiredFileSystemLocationNamesToAdd - The required file system location names to add to the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiredFileSystemLocationNamesToAdd

      UpdateQueueRequest.Builder requiredFileSystemLocationNamesToAdd(String... requiredFileSystemLocationNamesToAdd)

      The required file system location names to add to the queue.

      Parameters:
      requiredFileSystemLocationNamesToAdd - The required file system location names to add to the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiredFileSystemLocationNamesToRemove

      UpdateQueueRequest.Builder requiredFileSystemLocationNamesToRemove(Collection<String> requiredFileSystemLocationNamesToRemove)

      The required file system location names to remove from the queue.

      Parameters:
      requiredFileSystemLocationNamesToRemove - The required file system location names to remove from the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiredFileSystemLocationNamesToRemove

      UpdateQueueRequest.Builder requiredFileSystemLocationNamesToRemove(String... requiredFileSystemLocationNamesToRemove)

      The required file system location names to remove from the queue.

      Parameters:
      requiredFileSystemLocationNamesToRemove - The required file system location names to remove from the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedStorageProfileIdsToAdd

      UpdateQueueRequest.Builder allowedStorageProfileIdsToAdd(Collection<String> allowedStorageProfileIdsToAdd)

      The storage profile IDs to add.

      Parameters:
      allowedStorageProfileIdsToAdd - The storage profile IDs to add.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedStorageProfileIdsToAdd

      UpdateQueueRequest.Builder allowedStorageProfileIdsToAdd(String... allowedStorageProfileIdsToAdd)

      The storage profile IDs to add.

      Parameters:
      allowedStorageProfileIdsToAdd - The storage profile IDs to add.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedStorageProfileIdsToRemove

      UpdateQueueRequest.Builder allowedStorageProfileIdsToRemove(Collection<String> allowedStorageProfileIdsToRemove)

      The storage profile ID to remove.

      Parameters:
      allowedStorageProfileIdsToRemove - The storage profile ID to remove.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedStorageProfileIdsToRemove

      UpdateQueueRequest.Builder allowedStorageProfileIdsToRemove(String... allowedStorageProfileIdsToRemove)

      The storage profile ID to remove.

      Parameters:
      allowedStorageProfileIdsToRemove - The storage profile ID to remove.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedulingConfiguration

      UpdateQueueRequest.Builder schedulingConfiguration(SchedulingConfiguration schedulingConfiguration)

      The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.

      When updating the scheduling configuration, the entire configuration is replaced.

      In-progress tasks run to completion before the new scheduling configuration takes effect.

      Parameters:
      schedulingConfiguration - The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.

      When updating the scheduling configuration, the entire configuration is replaced.

      In-progress tasks run to completion before the new scheduling configuration takes effect.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedulingConfiguration

      default UpdateQueueRequest.Builder schedulingConfiguration(Consumer<SchedulingConfiguration.Builder> schedulingConfiguration)

      The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.

      When updating the scheduling configuration, the entire configuration is replaced.

      In-progress tasks run to completion before the new scheduling configuration takes effect.

      This is a convenience method that creates an instance of the SchedulingConfiguration.Builder avoiding the need to create one manually via SchedulingConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedulingConfiguration(SchedulingConfiguration).

      Parameters:
      schedulingConfiguration - a consumer that will call methods on SchedulingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateQueueRequest.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

      UpdateQueueRequest.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.