Interface CreateJobQueueRequest.Builder

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

  • Method Details

    • jobQueueName

      CreateJobQueueRequest.Builder jobQueueName(String jobQueueName)

      The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

      Parameters:
      jobQueueName - The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      CreateJobQueueRequest.Builder state(String state)

      The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

      Parameters:
      state - The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      CreateJobQueueRequest.Builder state(JQState state)

      The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

      Parameters:
      state - The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schedulingPolicyArn

      CreateJobQueueRequest.Builder schedulingPolicyArn(String schedulingPolicyArn)

      The Amazon Resource Name (ARN) of the fair-share scheduling policy. Job queues that don't have a fair-share scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a fair-share scheduling policy, it can be replaced but can't be removed.

      The format is aws:Partition:batch:Region:Account:scheduling-policy/Name .

      An example is aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

      A job queue without a fair-share scheduling policy is scheduled as a FIFO job queue and can't have a fair-share scheduling policy added. Jobs queues with a fair-share scheduling policy can have a maximum of 500 active share identifiers. When the limit has been reached, submissions of any jobs that add a new share identifier fail.

      Parameters:
      schedulingPolicyArn - The Amazon Resource Name (ARN) of the fair-share scheduling policy. Job queues that don't have a fair-share scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a fair-share scheduling policy, it can be replaced but can't be removed.

      The format is aws:Partition:batch:Region:Account:scheduling-policy/Name .

      An example is aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

      A job queue without a fair-share scheduling policy is scheduled as a FIFO job queue and can't have a fair-share scheduling policy added. Jobs queues with a fair-share scheduling policy can have a maximum of 500 active share identifiers. When the limit has been reached, submissions of any jobs that add a new share identifier fail.

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

    • priority

      CreateJobQueueRequest.Builder priority(Integer priority)

      The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

      Parameters:
      priority - The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computeEnvironmentOrder

      CreateJobQueueRequest.Builder computeEnvironmentOrder(Collection<ComputeEnvironmentOrder> computeEnvironmentOrder)

      The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

      All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

      Parameters:
      computeEnvironmentOrder - The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

      All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

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

    • computeEnvironmentOrder

      CreateJobQueueRequest.Builder computeEnvironmentOrder(ComputeEnvironmentOrder... computeEnvironmentOrder)

      The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

      All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

      Parameters:
      computeEnvironmentOrder - The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

      All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

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

    • computeEnvironmentOrder

      CreateJobQueueRequest.Builder computeEnvironmentOrder(Consumer<ComputeEnvironmentOrder.Builder>... computeEnvironmentOrder)

      The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

      All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to computeEnvironmentOrder(List<ComputeEnvironmentOrder>).

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

    • serviceEnvironmentOrder

      CreateJobQueueRequest.Builder serviceEnvironmentOrder(Collection<ServiceEnvironmentOrder> serviceEnvironmentOrder)

      A list of service environments that this job queue can use to allocate jobs. All serviceEnvironments must have the same type. A job queue can't have both a serviceEnvironmentOrder and a computeEnvironmentOrder field.

      Parameters:
      serviceEnvironmentOrder - A list of service environments that this job queue can use to allocate jobs. All serviceEnvironments must have the same type. A job queue can't have both a serviceEnvironmentOrder and a computeEnvironmentOrder field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceEnvironmentOrder

      CreateJobQueueRequest.Builder serviceEnvironmentOrder(ServiceEnvironmentOrder... serviceEnvironmentOrder)

      A list of service environments that this job queue can use to allocate jobs. All serviceEnvironments must have the same type. A job queue can't have both a serviceEnvironmentOrder and a computeEnvironmentOrder field.

      Parameters:
      serviceEnvironmentOrder - A list of service environments that this job queue can use to allocate jobs. All serviceEnvironments must have the same type. A job queue can't have both a serviceEnvironmentOrder and a computeEnvironmentOrder field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceEnvironmentOrder

      CreateJobQueueRequest.Builder serviceEnvironmentOrder(Consumer<ServiceEnvironmentOrder.Builder>... serviceEnvironmentOrder)

      A list of service environments that this job queue can use to allocate jobs. All serviceEnvironments must have the same type. A job queue can't have both a serviceEnvironmentOrder and a computeEnvironmentOrder field.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serviceEnvironmentOrder(List<ServiceEnvironmentOrder>).

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

    • jobQueueType

      CreateJobQueueRequest.Builder jobQueueType(String jobQueueType)

      The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS , or ECS_FARGATE depending on the compute environment.

      Parameters:
      jobQueueType - The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobQueueType

      CreateJobQueueRequest.Builder jobQueueType(JobQueueType jobQueueType)

      The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS , or ECS_FARGATE depending on the compute environment.

      Parameters:
      jobQueueType - The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

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

      The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.

      Parameters:
      tags - The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobStateTimeLimitActions

      CreateJobQueueRequest.Builder jobStateTimeLimitActions(Collection<JobStateTimeLimitAction> jobStateTimeLimitActions)

      The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)

      Parameters:
      jobStateTimeLimitActions - The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobStateTimeLimitActions

      CreateJobQueueRequest.Builder jobStateTimeLimitActions(JobStateTimeLimitAction... jobStateTimeLimitActions)

      The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)

      Parameters:
      jobStateTimeLimitActions - The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobStateTimeLimitActions

      CreateJobQueueRequest.Builder jobStateTimeLimitActions(Consumer<JobStateTimeLimitAction.Builder>... jobStateTimeLimitActions)

      The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobStateTimeLimitActions(List<JobStateTimeLimitAction>).

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

    • overrideConfiguration

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

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