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

#include <DescribeJobDefinitionsRequest.h>

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

Public Member Functions

 DescribeJobDefinitionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetJobDefinitions () const
 
bool JobDefinitionsHasBeenSet () const
 
void SetJobDefinitions (const Aws::Vector< Aws::String > &value)
 
void SetJobDefinitions (Aws::Vector< Aws::String > &&value)
 
DescribeJobDefinitionsRequestWithJobDefinitions (const Aws::Vector< Aws::String > &value)
 
DescribeJobDefinitionsRequestWithJobDefinitions (Aws::Vector< Aws::String > &&value)
 
DescribeJobDefinitionsRequestAddJobDefinitions (const Aws::String &value)
 
DescribeJobDefinitionsRequestAddJobDefinitions (Aws::String &&value)
 
DescribeJobDefinitionsRequestAddJobDefinitions (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeJobDefinitionsRequestWithMaxResults (int value)
 
const Aws::StringGetJobDefinitionName () const
 
bool JobDefinitionNameHasBeenSet () const
 
void SetJobDefinitionName (const Aws::String &value)
 
void SetJobDefinitionName (Aws::String &&value)
 
void SetJobDefinitionName (const char *value)
 
DescribeJobDefinitionsRequestWithJobDefinitionName (const Aws::String &value)
 
DescribeJobDefinitionsRequestWithJobDefinitionName (Aws::String &&value)
 
DescribeJobDefinitionsRequestWithJobDefinitionName (const char *value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
DescribeJobDefinitionsRequestWithStatus (const Aws::String &value)
 
DescribeJobDefinitionsRequestWithStatus (Aws::String &&value)
 
DescribeJobDefinitionsRequestWithStatus (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeJobDefinitionsRequestWithNextToken (const Aws::String &value)
 
DescribeJobDefinitionsRequestWithNextToken (Aws::String &&value)
 
DescribeJobDefinitionsRequestWithNextToken (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 DescribeJobDefinitions.

See Also:

AWS API Reference

Definition at line 26 of file DescribeJobDefinitionsRequest.h.

Constructor & Destructor Documentation

◆ DescribeJobDefinitionsRequest()

Aws::Batch::Model::DescribeJobDefinitionsRequest::DescribeJobDefinitionsRequest ( )

Member Function Documentation

◆ AddJobDefinitions() [1/3]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::AddJobDefinitions ( Aws::String &&  value)
inline

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

Definition at line 86 of file DescribeJobDefinitionsRequest.h.

◆ AddJobDefinitions() [2/3]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::AddJobDefinitions ( const Aws::String value)
inline

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

Definition at line 80 of file DescribeJobDefinitionsRequest.h.

◆ AddJobDefinitions() [3/3]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::AddJobDefinitions ( const char *  value)
inline

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

Definition at line 92 of file DescribeJobDefinitionsRequest.h.

◆ GetJobDefinitionName()

const Aws::String& Aws::Batch::Model::DescribeJobDefinitionsRequest::GetJobDefinitionName ( ) const
inline

The name of the job definition to describe.

Definition at line 151 of file DescribeJobDefinitionsRequest.h.

◆ GetJobDefinitions()

const Aws::Vector<Aws::String>& Aws::Batch::Model::DescribeJobDefinitionsRequest::GetJobDefinitions ( ) const
inline

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

Definition at line 44 of file DescribeJobDefinitionsRequest.h.

◆ GetMaxResults()

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

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions 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 DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

Definition at line 106 of file DescribeJobDefinitionsRequest.h.

◆ GetNextToken()

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

The nextToken value returned from a previous paginated DescribeJobDefinitions 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 240 of file DescribeJobDefinitionsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeJobDefinitionsRequest.h.

◆ GetStatus()

const Aws::String& Aws::Batch::Model::DescribeJobDefinitionsRequest::GetStatus ( ) const
inline

The status used to filter job definitions.

Definition at line 192 of file DescribeJobDefinitionsRequest.h.

◆ JobDefinitionNameHasBeenSet()

bool Aws::Batch::Model::DescribeJobDefinitionsRequest::JobDefinitionNameHasBeenSet ( ) const
inline

The name of the job definition to describe.

Definition at line 156 of file DescribeJobDefinitionsRequest.h.

◆ JobDefinitionsHasBeenSet()

bool Aws::Batch::Model::DescribeJobDefinitionsRequest::JobDefinitionsHasBeenSet ( ) const
inline

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

Definition at line 50 of file DescribeJobDefinitionsRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions 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 DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

Definition at line 119 of file DescribeJobDefinitionsRequest.h.

◆ NextTokenHasBeenSet()

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

The nextToken value returned from a previous paginated DescribeJobDefinitions 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 252 of file DescribeJobDefinitionsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetJobDefinitionName() [1/3]

void Aws::Batch::Model::DescribeJobDefinitionsRequest::SetJobDefinitionName ( Aws::String &&  value)
inline

The name of the job definition to describe.

Definition at line 166 of file DescribeJobDefinitionsRequest.h.

◆ SetJobDefinitionName() [2/3]

void Aws::Batch::Model::DescribeJobDefinitionsRequest::SetJobDefinitionName ( const Aws::String value)
inline

The name of the job definition to describe.

Definition at line 161 of file DescribeJobDefinitionsRequest.h.

◆ SetJobDefinitionName() [3/3]

void Aws::Batch::Model::DescribeJobDefinitionsRequest::SetJobDefinitionName ( const char *  value)
inline

The name of the job definition to describe.

Definition at line 171 of file DescribeJobDefinitionsRequest.h.

◆ SetJobDefinitions() [1/2]

void Aws::Batch::Model::DescribeJobDefinitionsRequest::SetJobDefinitions ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 62 of file DescribeJobDefinitionsRequest.h.

◆ SetJobDefinitions() [2/2]

void Aws::Batch::Model::DescribeJobDefinitionsRequest::SetJobDefinitions ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 56 of file DescribeJobDefinitionsRequest.h.

◆ SetMaxResults()

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

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions 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 DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

Definition at line 132 of file DescribeJobDefinitionsRequest.h.

◆ SetNextToken() [1/3]

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

The nextToken value returned from a previous paginated DescribeJobDefinitions 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 276 of file DescribeJobDefinitionsRequest.h.

◆ SetNextToken() [2/3]

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

The nextToken value returned from a previous paginated DescribeJobDefinitions 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 264 of file DescribeJobDefinitionsRequest.h.

◆ SetNextToken() [3/3]

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

The nextToken value returned from a previous paginated DescribeJobDefinitions 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 288 of file DescribeJobDefinitionsRequest.h.

◆ SetStatus() [1/3]

void Aws::Batch::Model::DescribeJobDefinitionsRequest::SetStatus ( Aws::String &&  value)
inline

The status used to filter job definitions.

Definition at line 207 of file DescribeJobDefinitionsRequest.h.

◆ SetStatus() [2/3]

void Aws::Batch::Model::DescribeJobDefinitionsRequest::SetStatus ( const Aws::String value)
inline

The status used to filter job definitions.

Definition at line 202 of file DescribeJobDefinitionsRequest.h.

◆ SetStatus() [3/3]

void Aws::Batch::Model::DescribeJobDefinitionsRequest::SetStatus ( const char *  value)
inline

The status used to filter job definitions.

Definition at line 212 of file DescribeJobDefinitionsRequest.h.

◆ StatusHasBeenSet()

bool Aws::Batch::Model::DescribeJobDefinitionsRequest::StatusHasBeenSet ( ) const
inline

The status used to filter job definitions.

Definition at line 197 of file DescribeJobDefinitionsRequest.h.

◆ WithJobDefinitionName() [1/3]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::WithJobDefinitionName ( Aws::String &&  value)
inline

The name of the job definition to describe.

Definition at line 181 of file DescribeJobDefinitionsRequest.h.

◆ WithJobDefinitionName() [2/3]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::WithJobDefinitionName ( const Aws::String value)
inline

The name of the job definition to describe.

Definition at line 176 of file DescribeJobDefinitionsRequest.h.

◆ WithJobDefinitionName() [3/3]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::WithJobDefinitionName ( const char *  value)
inline

The name of the job definition to describe.

Definition at line 186 of file DescribeJobDefinitionsRequest.h.

◆ WithJobDefinitions() [1/2]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::WithJobDefinitions ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 74 of file DescribeJobDefinitionsRequest.h.

◆ WithJobDefinitions() [2/2]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::WithJobDefinitions ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 68 of file DescribeJobDefinitionsRequest.h.

◆ WithMaxResults()

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

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions 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 DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

Definition at line 145 of file DescribeJobDefinitionsRequest.h.

◆ WithNextToken() [1/3]

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

The nextToken value returned from a previous paginated DescribeJobDefinitions 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 312 of file DescribeJobDefinitionsRequest.h.

◆ WithNextToken() [2/3]

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

The nextToken value returned from a previous paginated DescribeJobDefinitions 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 300 of file DescribeJobDefinitionsRequest.h.

◆ WithNextToken() [3/3]

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

The nextToken value returned from a previous paginated DescribeJobDefinitions 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 324 of file DescribeJobDefinitionsRequest.h.

◆ WithStatus() [1/3]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::WithStatus ( Aws::String &&  value)
inline

The status used to filter job definitions.

Definition at line 222 of file DescribeJobDefinitionsRequest.h.

◆ WithStatus() [2/3]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::WithStatus ( const Aws::String value)
inline

The status used to filter job definitions.

Definition at line 217 of file DescribeJobDefinitionsRequest.h.

◆ WithStatus() [3/3]

DescribeJobDefinitionsRequest& Aws::Batch::Model::DescribeJobDefinitionsRequest::WithStatus ( const char *  value)
inline

The status used to filter job definitions.

Definition at line 227 of file DescribeJobDefinitionsRequest.h.


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