AWS SDK for C++  1.9.3
AWS SDK for C++
Public Member Functions | List of all members
Aws::Batch::Model::UpdateJobQueueRequest Class Reference

#include <UpdateJobQueueRequest.h>

+ Inheritance diagram for Aws::Batch::Model::UpdateJobQueueRequest:

Public Member Functions

 UpdateJobQueueRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetJobQueue () const
 
bool JobQueueHasBeenSet () const
 
void SetJobQueue (const Aws::String &value)
 
void SetJobQueue (Aws::String &&value)
 
void SetJobQueue (const char *value)
 
UpdateJobQueueRequestWithJobQueue (const Aws::String &value)
 
UpdateJobQueueRequestWithJobQueue (Aws::String &&value)
 
UpdateJobQueueRequestWithJobQueue (const char *value)
 
const JQStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const JQState &value)
 
void SetState (JQState &&value)
 
UpdateJobQueueRequestWithState (const JQState &value)
 
UpdateJobQueueRequestWithState (JQState &&value)
 
int GetPriority () const
 
bool PriorityHasBeenSet () const
 
void SetPriority (int value)
 
UpdateJobQueueRequestWithPriority (int value)
 
const Aws::Vector< ComputeEnvironmentOrder > & GetComputeEnvironmentOrder () const
 
bool ComputeEnvironmentOrderHasBeenSet () const
 
void SetComputeEnvironmentOrder (const Aws::Vector< ComputeEnvironmentOrder > &value)
 
void SetComputeEnvironmentOrder (Aws::Vector< ComputeEnvironmentOrder > &&value)
 
UpdateJobQueueRequestWithComputeEnvironmentOrder (const Aws::Vector< ComputeEnvironmentOrder > &value)
 
UpdateJobQueueRequestWithComputeEnvironmentOrder (Aws::Vector< ComputeEnvironmentOrder > &&value)
 
UpdateJobQueueRequestAddComputeEnvironmentOrder (const ComputeEnvironmentOrder &value)
 
UpdateJobQueueRequestAddComputeEnvironmentOrder (ComputeEnvironmentOrder &&value)
 
- Public Member Functions inherited from Aws::Batch::BatchRequest
virtual ~BatchRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Batch::BatchRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Contains the parameters for UpdateJobQueue.

See Also:

AWS API Reference

Definition at line 28 of file UpdateJobQueueRequest.h.

Constructor & Destructor Documentation

◆ UpdateJobQueueRequest()

Aws::Batch::Model::UpdateJobQueueRequest::UpdateJobQueueRequest ( )

Member Function Documentation

◆ AddComputeEnvironmentOrder() [1/2]

UpdateJobQueueRequest& Aws::Batch::Model::UpdateJobQueueRequest::AddComputeEnvironmentOrder ( ComputeEnvironmentOrder &&  value)
inline

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 should run 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. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Definition at line 295 of file UpdateJobQueueRequest.h.

◆ AddComputeEnvironmentOrder() [2/2]

UpdateJobQueueRequest& Aws::Batch::Model::UpdateJobQueueRequest::AddComputeEnvironmentOrder ( const ComputeEnvironmentOrder value)
inline

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 should run 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. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Definition at line 281 of file UpdateJobQueueRequest.h.

◆ ComputeEnvironmentOrderHasBeenSet()

bool Aws::Batch::Model::UpdateJobQueueRequest::ComputeEnvironmentOrderHasBeenSet ( ) const
inline

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 should run 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. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Definition at line 211 of file UpdateJobQueueRequest.h.

◆ GetComputeEnvironmentOrder()

const Aws::Vector<ComputeEnvironmentOrder>& Aws::Batch::Model::UpdateJobQueueRequest::GetComputeEnvironmentOrder ( ) const
inline

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 should run 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. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Definition at line 197 of file UpdateJobQueueRequest.h.

◆ GetJobQueue()

const Aws::String& Aws::Batch::Model::UpdateJobQueueRequest::GetJobQueue ( ) const
inline

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

Definition at line 45 of file UpdateJobQueueRequest.h.

◆ GetPriority()

int Aws::Batch::Model::UpdateJobQueueRequest::GetPriority ( ) const
inline

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.

Definition at line 143 of file UpdateJobQueueRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Batch::Model::UpdateJobQueueRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file UpdateJobQueueRequest.h.

◆ GetState()

const JQState& Aws::Batch::Model::UpdateJobQueueRequest::GetState ( ) const
inline

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.

Definition at line 89 of file UpdateJobQueueRequest.h.

◆ JobQueueHasBeenSet()

bool Aws::Batch::Model::UpdateJobQueueRequest::JobQueueHasBeenSet ( ) const
inline

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

Definition at line 50 of file UpdateJobQueueRequest.h.

◆ PriorityHasBeenSet()

bool Aws::Batch::Model::UpdateJobQueueRequest::PriorityHasBeenSet ( ) const
inline

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.

Definition at line 156 of file UpdateJobQueueRequest.h.

◆ SerializePayload()

Aws::String Aws::Batch::Model::UpdateJobQueueRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetComputeEnvironmentOrder() [1/2]

void Aws::Batch::Model::UpdateJobQueueRequest::SetComputeEnvironmentOrder ( Aws::Vector< ComputeEnvironmentOrder > &&  value)
inline

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 should run 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. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Definition at line 239 of file UpdateJobQueueRequest.h.

◆ SetComputeEnvironmentOrder() [2/2]

void Aws::Batch::Model::UpdateJobQueueRequest::SetComputeEnvironmentOrder ( const Aws::Vector< ComputeEnvironmentOrder > &  value)
inline

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 should run 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. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Definition at line 225 of file UpdateJobQueueRequest.h.

◆ SetJobQueue() [1/3]

void Aws::Batch::Model::UpdateJobQueueRequest::SetJobQueue ( Aws::String &&  value)
inline

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

Definition at line 60 of file UpdateJobQueueRequest.h.

◆ SetJobQueue() [2/3]

void Aws::Batch::Model::UpdateJobQueueRequest::SetJobQueue ( const Aws::String value)
inline

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

Definition at line 55 of file UpdateJobQueueRequest.h.

◆ SetJobQueue() [3/3]

void Aws::Batch::Model::UpdateJobQueueRequest::SetJobQueue ( const char *  value)
inline

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

Definition at line 65 of file UpdateJobQueueRequest.h.

◆ SetPriority()

void Aws::Batch::Model::UpdateJobQueueRequest::SetPriority ( int  value)
inline

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.

Definition at line 169 of file UpdateJobQueueRequest.h.

◆ SetState() [1/2]

void Aws::Batch::Model::UpdateJobQueueRequest::SetState ( const JQState value)
inline

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.

Definition at line 105 of file UpdateJobQueueRequest.h.

◆ SetState() [2/2]

void Aws::Batch::Model::UpdateJobQueueRequest::SetState ( JQState &&  value)
inline

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.

Definition at line 113 of file UpdateJobQueueRequest.h.

◆ StateHasBeenSet()

bool Aws::Batch::Model::UpdateJobQueueRequest::StateHasBeenSet ( ) const
inline

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.

Definition at line 97 of file UpdateJobQueueRequest.h.

◆ WithComputeEnvironmentOrder() [1/2]

UpdateJobQueueRequest& Aws::Batch::Model::UpdateJobQueueRequest::WithComputeEnvironmentOrder ( Aws::Vector< ComputeEnvironmentOrder > &&  value)
inline

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 should run 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. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Definition at line 267 of file UpdateJobQueueRequest.h.

◆ WithComputeEnvironmentOrder() [2/2]

UpdateJobQueueRequest& Aws::Batch::Model::UpdateJobQueueRequest::WithComputeEnvironmentOrder ( const Aws::Vector< ComputeEnvironmentOrder > &  value)
inline

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 should run 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. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.

Definition at line 253 of file UpdateJobQueueRequest.h.

◆ WithJobQueue() [1/3]

UpdateJobQueueRequest& Aws::Batch::Model::UpdateJobQueueRequest::WithJobQueue ( Aws::String &&  value)
inline

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

Definition at line 75 of file UpdateJobQueueRequest.h.

◆ WithJobQueue() [2/3]

UpdateJobQueueRequest& Aws::Batch::Model::UpdateJobQueueRequest::WithJobQueue ( const Aws::String value)
inline

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

Definition at line 70 of file UpdateJobQueueRequest.h.

◆ WithJobQueue() [3/3]

UpdateJobQueueRequest& Aws::Batch::Model::UpdateJobQueueRequest::WithJobQueue ( const char *  value)
inline

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

Definition at line 80 of file UpdateJobQueueRequest.h.

◆ WithPriority()

UpdateJobQueueRequest& Aws::Batch::Model::UpdateJobQueueRequest::WithPriority ( int  value)
inline

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.

Definition at line 182 of file UpdateJobQueueRequest.h.

◆ WithState() [1/2]

UpdateJobQueueRequest& Aws::Batch::Model::UpdateJobQueueRequest::WithState ( const JQState value)
inline

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.

Definition at line 121 of file UpdateJobQueueRequest.h.

◆ WithState() [2/2]

UpdateJobQueueRequest& Aws::Batch::Model::UpdateJobQueueRequest::WithState ( JQState &&  value)
inline

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.

Definition at line 129 of file UpdateJobQueueRequest.h.


The documentation for this class was generated from the following file: