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

        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.