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

#include <DescribeComputeEnvironmentsRequest.h>

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

Public Member Functions

 DescribeComputeEnvironmentsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetComputeEnvironments () const
 
bool ComputeEnvironmentsHasBeenSet () const
 
void SetComputeEnvironments (const Aws::Vector< Aws::String > &value)
 
void SetComputeEnvironments (Aws::Vector< Aws::String > &&value)
 
DescribeComputeEnvironmentsRequestWithComputeEnvironments (const Aws::Vector< Aws::String > &value)
 
DescribeComputeEnvironmentsRequestWithComputeEnvironments (Aws::Vector< Aws::String > &&value)
 
DescribeComputeEnvironmentsRequestAddComputeEnvironments (const Aws::String &value)
 
DescribeComputeEnvironmentsRequestAddComputeEnvironments (Aws::String &&value)
 
DescribeComputeEnvironmentsRequestAddComputeEnvironments (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeComputeEnvironmentsRequestWithMaxResults (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)
 
DescribeComputeEnvironmentsRequestWithNextToken (const Aws::String &value)
 
DescribeComputeEnvironmentsRequestWithNextToken (Aws::String &&value)
 
DescribeComputeEnvironmentsRequestWithNextToken (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 DescribeComputeEnvironments.

See Also:

AWS API Reference

Definition at line 26 of file DescribeComputeEnvironmentsRequest.h.

Constructor & Destructor Documentation

◆ DescribeComputeEnvironmentsRequest()

Aws::Batch::Model::DescribeComputeEnvironmentsRequest::DescribeComputeEnvironmentsRequest ( )

Member Function Documentation

◆ AddComputeEnvironments() [1/3]

DescribeComputeEnvironmentsRequest& Aws::Batch::Model::DescribeComputeEnvironmentsRequest::AddComputeEnvironments ( Aws::String &&  value)
inline

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

Definition at line 86 of file DescribeComputeEnvironmentsRequest.h.

◆ AddComputeEnvironments() [2/3]

DescribeComputeEnvironmentsRequest& Aws::Batch::Model::DescribeComputeEnvironmentsRequest::AddComputeEnvironments ( const Aws::String value)
inline

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

Definition at line 80 of file DescribeComputeEnvironmentsRequest.h.

◆ AddComputeEnvironments() [3/3]

DescribeComputeEnvironmentsRequest& Aws::Batch::Model::DescribeComputeEnvironmentsRequest::AddComputeEnvironments ( const char *  value)
inline

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

Definition at line 92 of file DescribeComputeEnvironmentsRequest.h.

◆ ComputeEnvironmentsHasBeenSet()

bool Aws::Batch::Model::DescribeComputeEnvironmentsRequest::ComputeEnvironmentsHasBeenSet ( ) const
inline

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

Definition at line 50 of file DescribeComputeEnvironmentsRequest.h.

◆ GetComputeEnvironments()

const Aws::Vector<Aws::String>& Aws::Batch::Model::DescribeComputeEnvironmentsRequest::GetComputeEnvironments ( ) const
inline

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

Definition at line 44 of file DescribeComputeEnvironmentsRequest.h.

◆ GetMaxResults()

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

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

Definition at line 107 of file DescribeComputeEnvironmentsRequest.h.

◆ GetNextToken()

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments 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 162 of file DescribeComputeEnvironmentsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeComputeEnvironmentsRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

Definition at line 121 of file DescribeComputeEnvironmentsRequest.h.

◆ NextTokenHasBeenSet()

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments 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 174 of file DescribeComputeEnvironmentsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetComputeEnvironments() [1/2]

void Aws::Batch::Model::DescribeComputeEnvironmentsRequest::SetComputeEnvironments ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 62 of file DescribeComputeEnvironmentsRequest.h.

◆ SetComputeEnvironments() [2/2]

void Aws::Batch::Model::DescribeComputeEnvironmentsRequest::SetComputeEnvironments ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 56 of file DescribeComputeEnvironmentsRequest.h.

◆ SetMaxResults()

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

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

Definition at line 135 of file DescribeComputeEnvironmentsRequest.h.

◆ SetNextToken() [1/3]

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments 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 198 of file DescribeComputeEnvironmentsRequest.h.

◆ SetNextToken() [2/3]

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments 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 186 of file DescribeComputeEnvironmentsRequest.h.

◆ SetNextToken() [3/3]

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments 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 210 of file DescribeComputeEnvironmentsRequest.h.

◆ WithComputeEnvironments() [1/2]

DescribeComputeEnvironmentsRequest& Aws::Batch::Model::DescribeComputeEnvironmentsRequest::WithComputeEnvironments ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 74 of file DescribeComputeEnvironmentsRequest.h.

◆ WithComputeEnvironments() [2/2]

DescribeComputeEnvironmentsRequest& Aws::Batch::Model::DescribeComputeEnvironmentsRequest::WithComputeEnvironments ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 68 of file DescribeComputeEnvironmentsRequest.h.

◆ WithMaxResults()

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

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

Definition at line 149 of file DescribeComputeEnvironmentsRequest.h.

◆ WithNextToken() [1/3]

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments 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 234 of file DescribeComputeEnvironmentsRequest.h.

◆ WithNextToken() [2/3]

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments 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 222 of file DescribeComputeEnvironmentsRequest.h.

◆ WithNextToken() [3/3]

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

The nextToken value returned from a previous paginated DescribeComputeEnvironments 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 246 of file DescribeComputeEnvironmentsRequest.h.


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