Interface CreateQueueRequest.Builder

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

  • Method Details

    • clientToken

      CreateQueueRequest.Builder clientToken(String clientToken)

      The unique token which the server uses to recognize retries of the same request.

      Parameters:
      clientToken - The unique token which the server uses to recognize retries of the same request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • farmId

      CreateQueueRequest.Builder farmId(String farmId)

      The farm ID of the farm to connect to the queue.

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

    • displayName

      CreateQueueRequest.Builder displayName(String displayName)

      The display name of the queue.

      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.

      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

      CreateQueueRequest.Builder description(String description)

      The description of the queue.

      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.

      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

      CreateQueueRequest.Builder defaultBudgetAction(String defaultBudgetAction)

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

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

    • defaultBudgetAction

      CreateQueueRequest.Builder defaultBudgetAction(DefaultQueueBudgetAction defaultBudgetAction)

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

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

    • jobAttachmentSettings

      CreateQueueRequest.Builder jobAttachmentSettings(JobAttachmentSettings jobAttachmentSettings)

      The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

      Parameters:
      jobAttachmentSettings - The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobAttachmentSettings

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

      The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

      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

      CreateQueueRequest.Builder roleArn(String roleArn)

      The IAM role ARN that workers will use while running jobs for this queue.

      Parameters:
      roleArn - The IAM role ARN that workers will use while running jobs for this queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobRunAsUser

      CreateQueueRequest.Builder jobRunAsUser(JobRunAsUser jobRunAsUser)

      The jobs in the queue run as the specified POSIX user.

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

    • jobRunAsUser

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

      The jobs in the queue run as the 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:

    • requiredFileSystemLocationNames

      CreateQueueRequest.Builder requiredFileSystemLocationNames(Collection<String> requiredFileSystemLocationNames)

      The file system location name to include in the queue.

      Parameters:
      requiredFileSystemLocationNames - The file system location name to include in the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiredFileSystemLocationNames

      CreateQueueRequest.Builder requiredFileSystemLocationNames(String... requiredFileSystemLocationNames)

      The file system location name to include in the queue.

      Parameters:
      requiredFileSystemLocationNames - The file system location name to include in the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedStorageProfileIds

      CreateQueueRequest.Builder allowedStorageProfileIds(Collection<String> allowedStorageProfileIds)

      The storage profile IDs to include in the queue.

      Parameters:
      allowedStorageProfileIds - The storage profile IDs to include in the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedStorageProfileIds

      CreateQueueRequest.Builder allowedStorageProfileIds(String... allowedStorageProfileIds)

      The storage profile IDs to include in the queue.

      Parameters:
      allowedStorageProfileIds - The storage profile IDs to include in the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateQueueRequest.Builder tags(Map<String,String> tags)

      Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

      Parameters:
      tags - Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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