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

#include <DescribeJobQueuesRequest.h>

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

Public Member Functions

 DescribeJobQueuesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetJobQueues () const
 
bool JobQueuesHasBeenSet () const
 
void SetJobQueues (const Aws::Vector< Aws::String > &value)
 
void SetJobQueues (Aws::Vector< Aws::String > &&value)
 
DescribeJobQueuesRequestWithJobQueues (const Aws::Vector< Aws::String > &value)
 
DescribeJobQueuesRequestWithJobQueues (Aws::Vector< Aws::String > &&value)
 
DescribeJobQueuesRequestAddJobQueues (const Aws::String &value)
 
DescribeJobQueuesRequestAddJobQueues (Aws::String &&value)
 
DescribeJobQueuesRequestAddJobQueues (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeJobQueuesRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeJobQueuesRequestWithNextToken (const Aws::String &value)
 
DescribeJobQueuesRequestWithNextToken (Aws::String &&value)
 
DescribeJobQueuesRequestWithNextToken (const char *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 DescribeJobQueues.

See Also:

AWS API Reference

Definition at line 26 of file DescribeJobQueuesRequest.h.

Constructor & Destructor Documentation

◆ DescribeJobQueuesRequest()

Aws::Batch::Model::DescribeJobQueuesRequest::DescribeJobQueuesRequest ( )

Member Function Documentation

◆ AddJobQueues() [1/3]

DescribeJobQueuesRequest& Aws::Batch::Model::DescribeJobQueuesRequest::AddJobQueues ( Aws::String &&  value)
inline

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Definition at line 86 of file DescribeJobQueuesRequest.h.

◆ AddJobQueues() [2/3]

DescribeJobQueuesRequest& Aws::Batch::Model::DescribeJobQueuesRequest::AddJobQueues ( const Aws::String value)
inline

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Definition at line 80 of file DescribeJobQueuesRequest.h.

◆ AddJobQueues() [3/3]

DescribeJobQueuesRequest& Aws::Batch::Model::DescribeJobQueuesRequest::AddJobQueues ( const char *  value)
inline

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Definition at line 92 of file DescribeJobQueuesRequest.h.

◆ GetJobQueues()

const Aws::Vector<Aws::String>& Aws::Batch::Model::DescribeJobQueuesRequest::GetJobQueues ( ) const
inline

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Definition at line 44 of file DescribeJobQueuesRequest.h.

◆ GetMaxResults()

int Aws::Batch::Model::DescribeJobQueuesRequest::GetMaxResults ( ) const
inline

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and

  1. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

Definition at line 105 of file DescribeJobQueuesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Batch::Model::DescribeJobQueuesRequest::GetNextToken ( ) const
inline

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 154 of file DescribeJobQueuesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeJobQueuesRequest.h.

◆ JobQueuesHasBeenSet()

bool Aws::Batch::Model::DescribeJobQueuesRequest::JobQueuesHasBeenSet ( ) const
inline

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Definition at line 50 of file DescribeJobQueuesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Batch::Model::DescribeJobQueuesRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and

  1. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

Definition at line 117 of file DescribeJobQueuesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Batch::Model::DescribeJobQueuesRequest::NextTokenHasBeenSet ( ) const
inline

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 166 of file DescribeJobQueuesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetJobQueues() [1/2]

void Aws::Batch::Model::DescribeJobQueuesRequest::SetJobQueues ( Aws::Vector< Aws::String > &&  value)
inline

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Definition at line 62 of file DescribeJobQueuesRequest.h.

◆ SetJobQueues() [2/2]

void Aws::Batch::Model::DescribeJobQueuesRequest::SetJobQueues ( const Aws::Vector< Aws::String > &  value)
inline

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Definition at line 56 of file DescribeJobQueuesRequest.h.

◆ SetMaxResults()

void Aws::Batch::Model::DescribeJobQueuesRequest::SetMaxResults ( int  value)
inline

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and

  1. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

Definition at line 129 of file DescribeJobQueuesRequest.h.

◆ SetNextToken() [1/3]

void Aws::Batch::Model::DescribeJobQueuesRequest::SetNextToken ( Aws::String &&  value)
inline

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 190 of file DescribeJobQueuesRequest.h.

◆ SetNextToken() [2/3]

void Aws::Batch::Model::DescribeJobQueuesRequest::SetNextToken ( const Aws::String value)
inline

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 178 of file DescribeJobQueuesRequest.h.

◆ SetNextToken() [3/3]

void Aws::Batch::Model::DescribeJobQueuesRequest::SetNextToken ( const char *  value)
inline

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 202 of file DescribeJobQueuesRequest.h.

◆ WithJobQueues() [1/2]

DescribeJobQueuesRequest& Aws::Batch::Model::DescribeJobQueuesRequest::WithJobQueues ( Aws::Vector< Aws::String > &&  value)
inline

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Definition at line 74 of file DescribeJobQueuesRequest.h.

◆ WithJobQueues() [2/2]

DescribeJobQueuesRequest& Aws::Batch::Model::DescribeJobQueuesRequest::WithJobQueues ( const Aws::Vector< Aws::String > &  value)
inline

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Definition at line 68 of file DescribeJobQueuesRequest.h.

◆ WithMaxResults()

DescribeJobQueuesRequest& Aws::Batch::Model::DescribeJobQueuesRequest::WithMaxResults ( int  value)
inline

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and

  1. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

Definition at line 141 of file DescribeJobQueuesRequest.h.

◆ WithNextToken() [1/3]

DescribeJobQueuesRequest& Aws::Batch::Model::DescribeJobQueuesRequest::WithNextToken ( Aws::String &&  value)
inline

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 226 of file DescribeJobQueuesRequest.h.

◆ WithNextToken() [2/3]

DescribeJobQueuesRequest& Aws::Batch::Model::DescribeJobQueuesRequest::WithNextToken ( const Aws::String value)
inline

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 214 of file DescribeJobQueuesRequest.h.

◆ WithNextToken() [3/3]

DescribeJobQueuesRequest& Aws::Batch::Model::DescribeJobQueuesRequest::WithNextToken ( const char *  value)
inline

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 238 of file DescribeJobQueuesRequest.h.


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