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

#include <ListJobsRequest.h>

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

Public Member Functions

 ListJobsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
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)
 
const OrderGetOrder () const
 
bool OrderHasBeenSet () const
 
void SetOrder (const Order &value)
 
void SetOrder (Order &&value)
 
ListJobsRequestWithOrder (const Order &value)
 
ListJobsRequestWithOrder (Order &&value)
 
const Aws::StringGetQueue () const
 
bool QueueHasBeenSet () const
 
void SetQueue (const Aws::String &value)
 
void SetQueue (Aws::String &&value)
 
void SetQueue (const char *value)
 
ListJobsRequestWithQueue (const Aws::String &value)
 
ListJobsRequestWithQueue (Aws::String &&value)
 
ListJobsRequestWithQueue (const char *value)
 
const JobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const JobStatus &value)
 
void SetStatus (JobStatus &&value)
 
ListJobsRequestWithStatus (const JobStatus &value)
 
ListJobsRequestWithStatus (JobStatus &&value)
 
- Public Member Functions inherited from Aws::MediaConvert::MediaConvertRequest
virtual ~MediaConvertRequest ()
 
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 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::MediaConvert::MediaConvertRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file ListJobsRequest.h.

Constructor & Destructor Documentation

◆ ListJobsRequest()

Aws::MediaConvert::Model::ListJobsRequest::ListJobsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::MediaConvert::Model::ListJobsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetMaxResults()

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

Optional. Number of jobs, up to twenty, that will be returned at one time.

Definition at line 46 of file ListJobsRequest.h.

◆ GetNextToken()

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

Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

Definition at line 68 of file ListJobsRequest.h.

◆ GetOrder()

const Order& Aws::MediaConvert::Model::ListJobsRequest::GetOrder ( ) const
inline

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Definition at line 117 of file ListJobsRequest.h.

◆ GetQueue()

const Aws::String& Aws::MediaConvert::Model::ListJobsRequest::GetQueue ( ) const
inline

Optional. Provide a queue name to get back only jobs from that queue.

Definition at line 153 of file ListJobsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file ListJobsRequest.h.

◆ GetStatus()

const JobStatus& Aws::MediaConvert::Model::ListJobsRequest::GetStatus ( ) const
inline

Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

Definition at line 195 of file ListJobsRequest.h.

◆ MaxResultsHasBeenSet()

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

Optional. Number of jobs, up to twenty, that will be returned at one time.

Definition at line 51 of file ListJobsRequest.h.

◆ NextTokenHasBeenSet()

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

Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

Definition at line 74 of file ListJobsRequest.h.

◆ OrderHasBeenSet()

bool Aws::MediaConvert::Model::ListJobsRequest::OrderHasBeenSet ( ) const
inline

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Definition at line 123 of file ListJobsRequest.h.

◆ QueueHasBeenSet()

bool Aws::MediaConvert::Model::ListJobsRequest::QueueHasBeenSet ( ) const
inline

Optional. Provide a queue name to get back only jobs from that queue.

Definition at line 158 of file ListJobsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

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

Optional. Number of jobs, up to twenty, that will be returned at one time.

Definition at line 56 of file ListJobsRequest.h.

◆ SetNextToken() [1/3]

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

Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

Definition at line 80 of file ListJobsRequest.h.

◆ SetNextToken() [2/3]

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

Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

Definition at line 86 of file ListJobsRequest.h.

◆ SetNextToken() [3/3]

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

Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

Definition at line 92 of file ListJobsRequest.h.

◆ SetOrder() [1/2]

void Aws::MediaConvert::Model::ListJobsRequest::SetOrder ( const Order value)
inline

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Definition at line 129 of file ListJobsRequest.h.

◆ SetOrder() [2/2]

void Aws::MediaConvert::Model::ListJobsRequest::SetOrder ( Order &&  value)
inline

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Definition at line 135 of file ListJobsRequest.h.

◆ SetQueue() [1/3]

void Aws::MediaConvert::Model::ListJobsRequest::SetQueue ( const Aws::String value)
inline

Optional. Provide a queue name to get back only jobs from that queue.

Definition at line 163 of file ListJobsRequest.h.

◆ SetQueue() [2/3]

void Aws::MediaConvert::Model::ListJobsRequest::SetQueue ( Aws::String &&  value)
inline

Optional. Provide a queue name to get back only jobs from that queue.

Definition at line 168 of file ListJobsRequest.h.

◆ SetQueue() [3/3]

void Aws::MediaConvert::Model::ListJobsRequest::SetQueue ( const char *  value)
inline

Optional. Provide a queue name to get back only jobs from that queue.

Definition at line 173 of file ListJobsRequest.h.

◆ SetStatus() [1/2]

void Aws::MediaConvert::Model::ListJobsRequest::SetStatus ( const JobStatus value)
inline

Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

Definition at line 207 of file ListJobsRequest.h.

◆ SetStatus() [2/2]

void Aws::MediaConvert::Model::ListJobsRequest::SetStatus ( JobStatus &&  value)
inline

Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

Definition at line 213 of file ListJobsRequest.h.

◆ StatusHasBeenSet()

bool Aws::MediaConvert::Model::ListJobsRequest::StatusHasBeenSet ( ) const
inline

Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

Definition at line 201 of file ListJobsRequest.h.

◆ WithMaxResults()

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

Optional. Number of jobs, up to twenty, that will be returned at one time.

Definition at line 61 of file ListJobsRequest.h.

◆ WithNextToken() [1/3]

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

Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

Definition at line 98 of file ListJobsRequest.h.

◆ WithNextToken() [2/3]

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

Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

Definition at line 104 of file ListJobsRequest.h.

◆ WithNextToken() [3/3]

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

Optional. Use this string, provided with the response to a previous request, to request the next batch of jobs.

Definition at line 110 of file ListJobsRequest.h.

◆ WithOrder() [1/2]

ListJobsRequest& Aws::MediaConvert::Model::ListJobsRequest::WithOrder ( const Order value)
inline

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Definition at line 141 of file ListJobsRequest.h.

◆ WithOrder() [2/2]

ListJobsRequest& Aws::MediaConvert::Model::ListJobsRequest::WithOrder ( Order &&  value)
inline

Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.

Definition at line 147 of file ListJobsRequest.h.

◆ WithQueue() [1/3]

ListJobsRequest& Aws::MediaConvert::Model::ListJobsRequest::WithQueue ( const Aws::String value)
inline

Optional. Provide a queue name to get back only jobs from that queue.

Definition at line 178 of file ListJobsRequest.h.

◆ WithQueue() [2/3]

ListJobsRequest& Aws::MediaConvert::Model::ListJobsRequest::WithQueue ( Aws::String &&  value)
inline

Optional. Provide a queue name to get back only jobs from that queue.

Definition at line 183 of file ListJobsRequest.h.

◆ WithQueue() [3/3]

ListJobsRequest& Aws::MediaConvert::Model::ListJobsRequest::WithQueue ( const char *  value)
inline

Optional. Provide a queue name to get back only jobs from that queue.

Definition at line 188 of file ListJobsRequest.h.

◆ WithStatus() [1/2]

ListJobsRequest& Aws::MediaConvert::Model::ListJobsRequest::WithStatus ( const JobStatus value)
inline

Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

Definition at line 219 of file ListJobsRequest.h.

◆ WithStatus() [2/2]

ListJobsRequest& Aws::MediaConvert::Model::ListJobsRequest::WithStatus ( JobStatus &&  value)
inline

Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.

Definition at line 225 of file ListJobsRequest.h.


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