Interface JobQueueDetail.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<JobQueueDetail.Builder,
,JobQueueDetail> SdkBuilder<JobQueueDetail.Builder,
,JobQueueDetail> SdkPojo
- Enclosing class:
JobQueueDetail
-
Method Summary
Modifier and TypeMethodDescriptioncomputeEnvironmentOrder
(Collection<ComputeEnvironmentOrder> computeEnvironmentOrder) The compute environments that are attached to the job queue and the order that job placement is preferred.computeEnvironmentOrder
(Consumer<ComputeEnvironmentOrder.Builder>... computeEnvironmentOrder) The compute environments that are attached to the job queue and the order that job placement is preferred.computeEnvironmentOrder
(ComputeEnvironmentOrder... computeEnvironmentOrder) The compute environments that are attached to the job queue and the order that job placement is preferred.jobQueueArn
(String jobQueueArn) The Amazon Resource Name (ARN) of the job queue.jobQueueName
(String jobQueueName) The job queue name.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.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.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.The priority of the job queue.schedulingPolicyArn
(String schedulingPolicyArn) The Amazon Resource Name (ARN) of the scheduling policy.Describes the ability of the queue to accept new jobs.Describes the ability of the queue to accept new jobs.The status of the job queue (for example,CREATING
orVALID
).The status of the job queue (for example,CREATING
orVALID
).statusReason
(String statusReason) A short, human-readable string to provide additional details for the current status of the job queue.The tags that are applied to the job queue.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
jobQueueName
The job queue name.
- Parameters:
jobQueueName
- The job queue name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobQueueArn
The Amazon Resource Name (ARN) of the job queue.
- Parameters:
jobQueueArn
- 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
Describes the ability of the queue to accept new jobs. If the job queue state is
ENABLED
, it can accept jobs. If the job queue state isDISABLED
, new jobs can't be added to the queue, but jobs already in the queue can finish.- Parameters:
state
- Describes the ability of the queue to accept new jobs. If the job queue state isENABLED
, it can accept jobs. If the job queue state isDISABLED
, 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
Describes the ability of the queue to accept new jobs. If the job queue state is
ENABLED
, it can accept jobs. If the job queue state isDISABLED
, new jobs can't be added to the queue, but jobs already in the queue can finish.- Parameters:
state
- Describes the ability of the queue to accept new jobs. If the job queue state isENABLED
, it can accept jobs. If the job queue state isDISABLED
, 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
The Amazon Resource Name (ARN) of the scheduling policy. 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
- The Amazon Resource Name (ARN) of the scheduling policy. The format isaws: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.
-
status
The status of the job queue (for example,
CREATING
orVALID
).- Parameters:
status
- The status of the job queue (for example,CREATING
orVALID
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the job queue (for example,
CREATING
orVALID
).- Parameters:
status
- The status of the job queue (for example,CREATING
orVALID
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusReason
A short, human-readable string to provide additional details for the current status of the job queue.
- Parameters:
statusReason
- A short, human-readable string to provide additional details for the current status of the job queue.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 of10
is given scheduling preference over a job queue with a priority value of1
. All of the compute environments must be either Amazon EC2 (EC2
orSPOT
) or Fargate (FARGATE
orFARGATE_SPOT
). Amazon 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 thepriority
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 of10
is given scheduling preference over a job queue with a priority value of1
. All of the compute environments must be either Amazon EC2 (EC2
orSPOT
) or Fargate (FARGATE
orFARGATE_SPOT
). Amazon 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
JobQueueDetail.Builder computeEnvironmentOrder(Collection<ComputeEnvironmentOrder> computeEnvironmentOrder) The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.
- Parameters:
computeEnvironmentOrder
- The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
computeEnvironmentOrder
The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.
- Parameters:
computeEnvironmentOrder
- The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
computeEnvironmentOrder
JobQueueDetail.Builder computeEnvironmentOrder(Consumer<ComputeEnvironmentOrder.Builder>... computeEnvironmentOrder) The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.
This is a convenience method that creates an instance of theComputeEnvironmentOrder.Builder
avoiding the need to create one manually viaComputeEnvironmentOrder.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocomputeEnvironmentOrder(List<ComputeEnvironmentOrder>)
.- Parameters:
computeEnvironmentOrder
- a consumer that will call methods onComputeEnvironmentOrder.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.
- Parameters:
tags
- The tags that are applied to the job queue. 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
JobQueueDetail.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 aftermaxTimeSeconds
has passed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobStateTimeLimitActions
JobQueueDetail.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 aftermaxTimeSeconds
has passed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
jobStateTimeLimitActions
JobQueueDetail.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
This is a convenience method that creates an instance of themaxTimeSeconds
has passed.JobStateTimeLimitAction.Builder
avoiding the need to create one manually viaJobStateTimeLimitAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tojobStateTimeLimitActions(List<JobStateTimeLimitAction>)
.- Parameters:
jobStateTimeLimitActions
- a consumer that will call methods onJobStateTimeLimitAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-