/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Batch { namespace Model { /** *

Contains the parameters for UpdateJobQueue.

See * Also:

AWS * API Reference

*/ class UpdateJobQueueRequest : public BatchRequest { public: AWS_BATCH_API UpdateJobQueueRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "UpdateJobQueue"; } AWS_BATCH_API Aws::String SerializePayload() const override; /** *

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

*/ inline const Aws::String& GetJobQueue() const{ return m_jobQueue; } /** *

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

*/ inline bool JobQueueHasBeenSet() const { return m_jobQueueHasBeenSet; } /** *

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

*/ inline void SetJobQueue(const Aws::String& value) { m_jobQueueHasBeenSet = true; m_jobQueue = value; } /** *

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

*/ inline void SetJobQueue(Aws::String&& value) { m_jobQueueHasBeenSet = true; m_jobQueue = std::move(value); } /** *

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

*/ inline void SetJobQueue(const char* value) { m_jobQueueHasBeenSet = true; m_jobQueue.assign(value); } /** *

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

*/ inline UpdateJobQueueRequest& WithJobQueue(const Aws::String& value) { SetJobQueue(value); return *this;} /** *

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

*/ inline UpdateJobQueueRequest& WithJobQueue(Aws::String&& value) { SetJobQueue(std::move(value)); return *this;} /** *

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

*/ inline UpdateJobQueueRequest& WithJobQueue(const char* value) { SetJobQueue(value); return *this;} /** *

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.

*/ inline const JQState& GetState() const{ return m_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.

*/ inline bool StateHasBeenSet() const { return m_stateHasBeenSet; } /** *

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.

*/ inline void SetState(const JQState& value) { m_stateHasBeenSet = true; m_state = value; } /** *

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.

*/ inline void SetState(JQState&& value) { m_stateHasBeenSet = true; m_state = std::move(value); } /** *

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.

*/ inline UpdateJobQueueRequest& WithState(const JQState& value) { SetState(value); return *this;} /** *

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.

*/ inline UpdateJobQueueRequest& WithState(JQState&& value) { SetState(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetSchedulingPolicyArn() const{ return m_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.

*/ inline bool SchedulingPolicyArnHasBeenSet() const { return m_schedulingPolicyArnHasBeenSet; } /** *

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.

*/ inline void SetSchedulingPolicyArn(const Aws::String& value) { m_schedulingPolicyArnHasBeenSet = true; m_schedulingPolicyArn = value; } /** *

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.

*/ inline void SetSchedulingPolicyArn(Aws::String&& value) { m_schedulingPolicyArnHasBeenSet = true; m_schedulingPolicyArn = std::move(value); } /** *

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.

*/ inline void SetSchedulingPolicyArn(const char* value) { m_schedulingPolicyArnHasBeenSet = true; m_schedulingPolicyArn.assign(value); } /** *

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.

*/ inline UpdateJobQueueRequest& WithSchedulingPolicyArn(const Aws::String& value) { SetSchedulingPolicyArn(value); return *this;} /** *

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.

*/ inline UpdateJobQueueRequest& WithSchedulingPolicyArn(Aws::String&& value) { SetSchedulingPolicyArn(std::move(value)); return *this;} /** *

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.

*/ inline UpdateJobQueueRequest& WithSchedulingPolicyArn(const char* value) { SetSchedulingPolicyArn(value); return *this;} /** *

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.

*/ inline int GetPriority() const{ return m_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.

*/ inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; } /** *

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.

*/ inline void SetPriority(int value) { m_priorityHasBeenSet = true; m_priority = value; } /** *

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.

*/ inline UpdateJobQueueRequest& WithPriority(int value) { SetPriority(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetComputeEnvironmentOrder() const{ return m_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.

*/ inline bool ComputeEnvironmentOrderHasBeenSet() const { return m_computeEnvironmentOrderHasBeenSet; } /** *

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.

*/ inline void SetComputeEnvironmentOrder(const Aws::Vector& value) { m_computeEnvironmentOrderHasBeenSet = true; m_computeEnvironmentOrder = value; } /** *

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.

*/ inline void SetComputeEnvironmentOrder(Aws::Vector&& value) { m_computeEnvironmentOrderHasBeenSet = true; m_computeEnvironmentOrder = std::move(value); } /** *

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.

*/ inline UpdateJobQueueRequest& WithComputeEnvironmentOrder(const Aws::Vector& value) { SetComputeEnvironmentOrder(value); return *this;} /** *

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.

*/ inline UpdateJobQueueRequest& WithComputeEnvironmentOrder(Aws::Vector&& value) { SetComputeEnvironmentOrder(std::move(value)); return *this;} /** *

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.

*/ inline UpdateJobQueueRequest& AddComputeEnvironmentOrder(const ComputeEnvironmentOrder& value) { m_computeEnvironmentOrderHasBeenSet = true; m_computeEnvironmentOrder.push_back(value); return *this; } /** *

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.

*/ inline UpdateJobQueueRequest& AddComputeEnvironmentOrder(ComputeEnvironmentOrder&& value) { m_computeEnvironmentOrderHasBeenSet = true; m_computeEnvironmentOrder.push_back(std::move(value)); return *this; } private: Aws::String m_jobQueue; bool m_jobQueueHasBeenSet = false; JQState m_state; bool m_stateHasBeenSet = false; Aws::String m_schedulingPolicyArn; bool m_schedulingPolicyArnHasBeenSet = false; int m_priority; bool m_priorityHasBeenSet = false; Aws::Vector m_computeEnvironmentOrder; bool m_computeEnvironmentOrderHasBeenSet = false; }; } // namespace Model } // namespace Batch } // namespace Aws