Interface GetQueueResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetQueueResponse.Builder,GetQueueResponse>, DeadlineResponse.Builder, SdkBuilder<GetQueueResponse.Builder,GetQueueResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetQueueResponse
@Mutable @NotThreadSafe public static interface GetQueueResponse.Builder extends DeadlineResponse.Builder, SdkPojo, CopyableBuilder<GetQueueResponse.Builder,GetQueueResponse>

  • Method Details

    • queueId

      GetQueueResponse.Builder queueId(String queueId)

      The queue ID.

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

    • displayName

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

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

    • farmId

      GetQueueResponse.Builder farmId(String farmId)

      The farm ID for the queue.

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

    • status

      GetQueueResponse.Builder status(String status)

      The status of the queue.

      • ACTIVE–The queue is active.

      • SCHEDULING–The queue is scheduling.

      • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

      Parameters:
      status - The status of the queue.

      • ACTIVE–The queue is active.

      • SCHEDULING–The queue is scheduling.

      • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

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

    • status

      GetQueueResponse.Builder status(QueueStatus status)

      The status of the queue.

      • ACTIVE–The queue is active.

      • SCHEDULING–The queue is scheduling.

      • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

      Parameters:
      status - The status of the queue.

      • ACTIVE–The queue is active.

      • SCHEDULING–The queue is scheduling.

      • SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.

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

    • defaultBudgetAction

      GetQueueResponse.Builder defaultBudgetAction(String defaultBudgetAction)

      The default action taken on a queue if a budget wasn't configured.

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

    • defaultBudgetAction

      GetQueueResponse.Builder defaultBudgetAction(DefaultQueueBudgetAction defaultBudgetAction)

      The default action taken on a queue if a budget wasn't configured.

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

    • blockedReason

      GetQueueResponse.Builder blockedReason(String blockedReason)

      The reason the queue was blocked.

      Parameters:
      blockedReason - The reason the queue was blocked.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • blockedReason

      GetQueueResponse.Builder blockedReason(QueueBlockedReason blockedReason)

      The reason the queue was blocked.

      Parameters:
      blockedReason - The reason the queue was blocked.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobAttachmentSettings

      GetQueueResponse.Builder jobAttachmentSettings(JobAttachmentSettings jobAttachmentSettings)

      The job attachment settings for the queue.

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

    • jobAttachmentSettings

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

      The job attachment settings 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

      GetQueueResponse.Builder roleArn(String roleArn)

      The IAM role ARN.

      Parameters:
      roleArn - The IAM role ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiredFileSystemLocationNames

      GetQueueResponse.Builder requiredFileSystemLocationNames(Collection<String> requiredFileSystemLocationNames)

      A list of the required file system location names in the queue.

      Parameters:
      requiredFileSystemLocationNames - A list of the required file system location names in the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requiredFileSystemLocationNames

      GetQueueResponse.Builder requiredFileSystemLocationNames(String... requiredFileSystemLocationNames)

      A list of the required file system location names in the queue.

      Parameters:
      requiredFileSystemLocationNames - A list of the required file system location names in the queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedStorageProfileIds

      GetQueueResponse.Builder allowedStorageProfileIds(Collection<String> allowedStorageProfileIds)

      The storage profile IDs for the queue.

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

    • allowedStorageProfileIds

      GetQueueResponse.Builder allowedStorageProfileIds(String... allowedStorageProfileIds)

      The storage profile IDs for the queue.

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

    • jobRunAsUser

      GetQueueResponse.Builder jobRunAsUser(JobRunAsUser jobRunAsUser)

      The jobs in the queue ran as this specified POSIX user.

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

    • jobRunAsUser

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

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

    • createdAt

      GetQueueResponse.Builder createdAt(Instant createdAt)

      The date and time the resource was created.

      Parameters:
      createdAt - The date and time the resource was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      GetQueueResponse.Builder createdBy(String createdBy)

      The user or system that created this resource.

      Parameters:
      createdBy - The user or system that created this resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      GetQueueResponse.Builder updatedAt(Instant updatedAt)

      The date and time the resource was updated.

      Parameters:
      updatedAt - The date and time the resource was updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedBy

      GetQueueResponse.Builder updatedBy(String updatedBy)

      The user or system that updated this resource.

      Parameters:
      updatedBy - The user or system that updated this resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.