Package software.amazon.awssdk.services.batch.model

Interface UpdateJobQueueRequest.Builder

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

  • Method Details

    • jobQueue

      UpdateJobQueueRequest.Builder jobQueue(String jobQueue)

      The name or the Amazon Resource Name (ARN) of the job queue.

      Parameters:
      jobQueue - The name or the Amazon Resource Name (ARN) of the job queue.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      UpdateJobQueueRequest.Builder state(String state)

      Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can 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 - Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can 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

      UpdateJobQueueRequest.Builder state(JQState state)

      Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can 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 - Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can 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

      UpdateJobQueueRequest.Builder schedulingPolicyArn(String schedulingPolicyArn)

      Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

      Parameters:
      schedulingPolicyArn - Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

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

      UpdateJobQueueRequest.Builder computeEnvironmentOrder(Collection<ComputeEnvironmentOrder> computeEnvironmentOrder)

      Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them 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 - Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them 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

      UpdateJobQueueRequest.Builder computeEnvironmentOrder(ComputeEnvironmentOrder... computeEnvironmentOrder)

      Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them 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 - Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them 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

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

      Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them 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:

    • jobStateTimeLimitActions

      UpdateJobQueueRequest.Builder jobStateTimeLimitActions(Collection<JobStateTimeLimitAction> jobStateTimeLimitActions)

      The set of actions that Batch perform 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.

      Parameters:
      jobStateTimeLimitActions - The set of actions that Batch perform 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobStateTimeLimitActions

      UpdateJobQueueRequest.Builder jobStateTimeLimitActions(JobStateTimeLimitAction... jobStateTimeLimitActions)

      The set of actions that Batch perform 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.

      Parameters:
      jobStateTimeLimitActions - The set of actions that Batch perform 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobStateTimeLimitActions

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

      The set of actions that Batch perform 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.

      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

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

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