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

#include <ListJobsRequest.h>

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

Public Member Functions

 ListJobsRequest ()
 
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)
 
ListJobsRequestWithJobQueue (const Aws::String &value)
 
ListJobsRequestWithJobQueue (Aws::String &&value)
 
ListJobsRequestWithJobQueue (const char *value)
 
const Aws::StringGetArrayJobId () const
 
bool ArrayJobIdHasBeenSet () const
 
void SetArrayJobId (const Aws::String &value)
 
void SetArrayJobId (Aws::String &&value)
 
void SetArrayJobId (const char *value)
 
ListJobsRequestWithArrayJobId (const Aws::String &value)
 
ListJobsRequestWithArrayJobId (Aws::String &&value)
 
ListJobsRequestWithArrayJobId (const char *value)
 
const Aws::StringGetMultiNodeJobId () const
 
bool MultiNodeJobIdHasBeenSet () const
 
void SetMultiNodeJobId (const Aws::String &value)
 
void SetMultiNodeJobId (Aws::String &&value)
 
void SetMultiNodeJobId (const char *value)
 
ListJobsRequestWithMultiNodeJobId (const Aws::String &value)
 
ListJobsRequestWithMultiNodeJobId (Aws::String &&value)
 
ListJobsRequestWithMultiNodeJobId (const char *value)
 
const JobStatusGetJobStatus () const
 
bool JobStatusHasBeenSet () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
ListJobsRequestWithJobStatus (const JobStatus &value)
 
ListJobsRequestWithJobStatus (JobStatus &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListJobsRequestWithMaxResults (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)
 
ListJobsRequestWithNextToken (const Aws::String &value)
 
ListJobsRequestWithNextToken (Aws::String &&value)
 
ListJobsRequestWithNextToken (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 ListJobs.

See Also:


AWS API Reference

Definition at line 26 of file ListJobsRequest.h.

Constructor & Destructor Documentation

◆ ListJobsRequest()

Aws::Batch::Model::ListJobsRequest::ListJobsRequest ( )

Member Function Documentation

◆ ArrayJobIdHasBeenSet()

bool Aws::Batch::Model::ListJobsRequest::ArrayJobIdHasBeenSet ( ) const
inline

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Definition at line 99 of file ListJobsRequest.h.

◆ GetArrayJobId()

const Aws::String& Aws::Batch::Model::ListJobsRequest::GetArrayJobId ( ) const
inline

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Definition at line 93 of file ListJobsRequest.h.

◆ GetJobQueue()

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

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

Definition at line 44 of file ListJobsRequest.h.

◆ GetJobStatus()

const JobStatus& Aws::Batch::Model::ListJobsRequest::GetJobStatus ( ) const
inline

The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.

Definition at line 199 of file ListJobsRequest.h.

◆ GetMaxResults()

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

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

Definition at line 242 of file ListJobsRequest.h.

◆ GetMultiNodeJobId()

const Aws::String& Aws::Batch::Model::ListJobsRequest::GetMultiNodeJobId ( ) const
inline

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Definition at line 143 of file ListJobsRequest.h.

◆ GetNextToken()

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

The nextToken value returned from a previous paginated ListJobs 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 291 of file ListJobsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file ListJobsRequest.h.

◆ JobQueueHasBeenSet()

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

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

Definition at line 50 of file ListJobsRequest.h.

◆ JobStatusHasBeenSet()

bool Aws::Batch::Model::ListJobsRequest::JobStatusHasBeenSet ( ) const
inline

The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.

Definition at line 205 of file ListJobsRequest.h.

◆ MaxResultsHasBeenSet()

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

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

Definition at line 254 of file ListJobsRequest.h.

◆ MultiNodeJobIdHasBeenSet()

bool Aws::Batch::Model::ListJobsRequest::MultiNodeJobIdHasBeenSet ( ) const
inline

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Definition at line 150 of file ListJobsRequest.h.

◆ NextTokenHasBeenSet()

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

The nextToken value returned from a previous paginated ListJobs 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 303 of file ListJobsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetArrayJobId() [1/3]

void Aws::Batch::Model::ListJobsRequest::SetArrayJobId ( Aws::String &&  value)
inline

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Definition at line 111 of file ListJobsRequest.h.

◆ SetArrayJobId() [2/3]

void Aws::Batch::Model::ListJobsRequest::SetArrayJobId ( const Aws::String value)
inline

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Definition at line 105 of file ListJobsRequest.h.

◆ SetArrayJobId() [3/3]

void Aws::Batch::Model::ListJobsRequest::SetArrayJobId ( const char *  value)
inline

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Definition at line 117 of file ListJobsRequest.h.

◆ SetJobQueue() [1/3]

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

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

Definition at line 62 of file ListJobsRequest.h.

◆ SetJobQueue() [2/3]

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

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

Definition at line 56 of file ListJobsRequest.h.

◆ SetJobQueue() [3/3]

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

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

Definition at line 68 of file ListJobsRequest.h.

◆ SetJobStatus() [1/2]

void Aws::Batch::Model::ListJobsRequest::SetJobStatus ( const JobStatus value)
inline

The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.

Definition at line 211 of file ListJobsRequest.h.

◆ SetJobStatus() [2/2]

void Aws::Batch::Model::ListJobsRequest::SetJobStatus ( JobStatus &&  value)
inline

The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.

Definition at line 217 of file ListJobsRequest.h.

◆ SetMaxResults()

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

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

Definition at line 266 of file ListJobsRequest.h.

◆ SetMultiNodeJobId() [1/3]

void Aws::Batch::Model::ListJobsRequest::SetMultiNodeJobId ( Aws::String &&  value)
inline

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Definition at line 164 of file ListJobsRequest.h.

◆ SetMultiNodeJobId() [2/3]

void Aws::Batch::Model::ListJobsRequest::SetMultiNodeJobId ( const Aws::String value)
inline

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Definition at line 157 of file ListJobsRequest.h.

◆ SetMultiNodeJobId() [3/3]

void Aws::Batch::Model::ListJobsRequest::SetMultiNodeJobId ( const char *  value)
inline

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Definition at line 171 of file ListJobsRequest.h.

◆ SetNextToken() [1/3]

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

The nextToken value returned from a previous paginated ListJobs 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 327 of file ListJobsRequest.h.

◆ SetNextToken() [2/3]

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

The nextToken value returned from a previous paginated ListJobs 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 315 of file ListJobsRequest.h.

◆ SetNextToken() [3/3]

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

The nextToken value returned from a previous paginated ListJobs 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 339 of file ListJobsRequest.h.

◆ WithArrayJobId() [1/3]

ListJobsRequest& Aws::Batch::Model::ListJobsRequest::WithArrayJobId ( Aws::String &&  value)
inline

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Definition at line 129 of file ListJobsRequest.h.

◆ WithArrayJobId() [2/3]

ListJobsRequest& Aws::Batch::Model::ListJobsRequest::WithArrayJobId ( const Aws::String value)
inline

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Definition at line 123 of file ListJobsRequest.h.

◆ WithArrayJobId() [3/3]

ListJobsRequest& Aws::Batch::Model::ListJobsRequest::WithArrayJobId ( const char *  value)
inline

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

Definition at line 135 of file ListJobsRequest.h.

◆ WithJobQueue() [1/3]

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

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

Definition at line 80 of file ListJobsRequest.h.

◆ WithJobQueue() [2/3]

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

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

Definition at line 74 of file ListJobsRequest.h.

◆ WithJobQueue() [3/3]

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

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

Definition at line 86 of file ListJobsRequest.h.

◆ WithJobStatus() [1/2]

ListJobsRequest& Aws::Batch::Model::ListJobsRequest::WithJobStatus ( const JobStatus value)
inline

The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.

Definition at line 223 of file ListJobsRequest.h.

◆ WithJobStatus() [2/2]

ListJobsRequest& Aws::Batch::Model::ListJobsRequest::WithJobStatus ( JobStatus &&  value)
inline

The job status used to filter jobs in the specified queue. If you don't specify a status, only RUNNING jobs are returned.

Definition at line 229 of file ListJobsRequest.h.

◆ WithMaxResults()

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

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

Definition at line 278 of file ListJobsRequest.h.

◆ WithMultiNodeJobId() [1/3]

ListJobsRequest& Aws::Batch::Model::ListJobsRequest::WithMultiNodeJobId ( Aws::String &&  value)
inline

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Definition at line 185 of file ListJobsRequest.h.

◆ WithMultiNodeJobId() [2/3]

ListJobsRequest& Aws::Batch::Model::ListJobsRequest::WithMultiNodeJobId ( const Aws::String value)
inline

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Definition at line 178 of file ListJobsRequest.h.

◆ WithMultiNodeJobId() [3/3]

ListJobsRequest& Aws::Batch::Model::ListJobsRequest::WithMultiNodeJobId ( const char *  value)
inline

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

Definition at line 192 of file ListJobsRequest.h.

◆ WithNextToken() [1/3]

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

The nextToken value returned from a previous paginated ListJobs 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 363 of file ListJobsRequest.h.

◆ WithNextToken() [2/3]

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

The nextToken value returned from a previous paginated ListJobs 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 351 of file ListJobsRequest.h.

◆ WithNextToken() [3/3]

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

The nextToken value returned from a previous paginated ListJobs 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 375 of file ListJobsRequest.h.


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