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

Interface JobQueueDetail.Builder

    • Method Detail

      • jobQueueName

        JobQueueDetail.Builder jobQueueName​(String 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

        JobQueueDetail.Builder jobQueueArn​(String 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

        JobQueueDetail.Builder state​(String 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 is DISABLED, 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 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:
        JQState, JQState

      • state

        JobQueueDetail.Builder state​(JQState 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 is DISABLED, 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 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:
        JQState, JQState

      • schedulingPolicyArn

        JobQueueDetail.Builder schedulingPolicyArn​(String 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 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.

      • status

        JobQueueDetail.Builder status​(String status)

        The status of the job queue (for example, CREATING or VALID).

        Parameters:
        status - The status of the job queue (for example, CREATING or VALID).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JQStatus, JQStatus

      • status

        JobQueueDetail.Builder status​(JQStatus status)

        The status of the job queue (for example, CREATING or VALID).

        Parameters:
        status - The status of the job queue (for example, CREATING or VALID).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JQStatus, JQStatus

      • statusReason

        JobQueueDetail.Builder statusReason​(String 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

        JobQueueDetail.Builder priority​(Integer priority)

        The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for priority indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of 10 is evaluated before a queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

        Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.

        Parameters:
        priority - The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for priority indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of 10 is evaluated before a queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

        Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.

        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

        JobQueueDetail.Builder computeEnvironmentOrder​(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.

      • 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 after maxTimeSeconds 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 after maxTimeSeconds 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 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).

        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:
        #jobStateTimeLimitActions(java.util.Collection)