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

#include <ListJobsRequest.h>

+ Inheritance diagram for Aws::S3Control::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
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAccountId () const
 
bool AccountIdHasBeenSet () const
 
void SetAccountId (const Aws::String &value)
 
void SetAccountId (Aws::String &&value)
 
void SetAccountId (const char *value)
 
ListJobsRequestWithAccountId (const Aws::String &value)
 
ListJobsRequestWithAccountId (Aws::String &&value)
 
ListJobsRequestWithAccountId (const char *value)
 
const Aws::Vector< JobStatus > & GetJobStatuses () const
 
bool JobStatusesHasBeenSet () const
 
void SetJobStatuses (const Aws::Vector< JobStatus > &value)
 
void SetJobStatuses (Aws::Vector< JobStatus > &&value)
 
ListJobsRequestWithJobStatuses (const Aws::Vector< JobStatus > &value)
 
ListJobsRequestWithJobStatuses (Aws::Vector< JobStatus > &&value)
 
ListJobsRequestAddJobStatuses (const JobStatus &value)
 
ListJobsRequestAddJobStatuses (JobStatus &&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)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListJobsRequestWithMaxResults (int value)
 
- Public Member Functions inherited from Aws::S3Control::S3ControlRequest
virtual ~S3ControlRequest ()
 
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::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file ListJobsRequest.h.

Constructor & Destructor Documentation

◆ ListJobsRequest()

Aws::S3Control::Model::ListJobsRequest::ListJobsRequest ( )

Member Function Documentation

◆ AccountIdHasBeenSet()

bool Aws::S3Control::Model::ListJobsRequest::AccountIdHasBeenSet ( ) const
inline

Definition at line 53 of file ListJobsRequest.h.

◆ AddJobStatuses() [1/2]

ListJobsRequest& Aws::S3Control::Model::ListJobsRequest::AddJobStatuses ( const JobStatus value)
inline

The List Jobs request returns jobs that match the statuses listed in this element.

Definition at line 126 of file ListJobsRequest.h.

◆ AddJobStatuses() [2/2]

ListJobsRequest& Aws::S3Control::Model::ListJobsRequest::AddJobStatuses ( JobStatus &&  value)
inline

The List Jobs request returns jobs that match the statuses listed in this element.

Definition at line 132 of file ListJobsRequest.h.

◆ AddQueryStringParameters()

void Aws::S3Control::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.

◆ GetAccountId()

const Aws::String& Aws::S3Control::Model::ListJobsRequest::GetAccountId ( ) const
inline

Definition at line 48 of file ListJobsRequest.h.

◆ GetJobStatuses()

const Aws::Vector<JobStatus>& Aws::S3Control::Model::ListJobsRequest::GetJobStatuses ( ) const
inline

The List Jobs request returns jobs that match the statuses listed in this element.

Definition at line 90 of file ListJobsRequest.h.

◆ GetMaxResults()

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

The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

Definition at line 206 of file ListJobsRequest.h.

◆ GetNextToken()

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

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

Definition at line 141 of file ListJobsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3Control::Model::ListJobsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::S3Control::S3ControlRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file ListJobsRequest.h.

◆ JobStatusesHasBeenSet()

bool Aws::S3Control::Model::ListJobsRequest::JobStatusesHasBeenSet ( ) const
inline

The List Jobs request returns jobs that match the statuses listed in this element.

Definition at line 96 of file ListJobsRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

Definition at line 214 of file ListJobsRequest.h.

◆ NextTokenHasBeenSet()

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

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

Definition at line 149 of file ListJobsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountId() [1/3]

void Aws::S3Control::Model::ListJobsRequest::SetAccountId ( const Aws::String value)
inline

Definition at line 58 of file ListJobsRequest.h.

◆ SetAccountId() [2/3]

void Aws::S3Control::Model::ListJobsRequest::SetAccountId ( Aws::String &&  value)
inline

Definition at line 63 of file ListJobsRequest.h.

◆ SetAccountId() [3/3]

void Aws::S3Control::Model::ListJobsRequest::SetAccountId ( const char *  value)
inline

Definition at line 68 of file ListJobsRequest.h.

◆ SetJobStatuses() [1/2]

void Aws::S3Control::Model::ListJobsRequest::SetJobStatuses ( const Aws::Vector< JobStatus > &  value)
inline

The List Jobs request returns jobs that match the statuses listed in this element.

Definition at line 102 of file ListJobsRequest.h.

◆ SetJobStatuses() [2/2]

void Aws::S3Control::Model::ListJobsRequest::SetJobStatuses ( Aws::Vector< JobStatus > &&  value)
inline

The List Jobs request returns jobs that match the statuses listed in this element.

Definition at line 108 of file ListJobsRequest.h.

◆ SetMaxResults()

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

The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

Definition at line 222 of file ListJobsRequest.h.

◆ SetNextToken() [1/3]

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

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

Definition at line 157 of file ListJobsRequest.h.

◆ SetNextToken() [2/3]

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

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

Definition at line 165 of file ListJobsRequest.h.

◆ SetNextToken() [3/3]

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

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

Definition at line 173 of file ListJobsRequest.h.

◆ WithAccountId() [1/3]

ListJobsRequest& Aws::S3Control::Model::ListJobsRequest::WithAccountId ( const Aws::String value)
inline

Definition at line 73 of file ListJobsRequest.h.

◆ WithAccountId() [2/3]

ListJobsRequest& Aws::S3Control::Model::ListJobsRequest::WithAccountId ( Aws::String &&  value)
inline

Definition at line 78 of file ListJobsRequest.h.

◆ WithAccountId() [3/3]

ListJobsRequest& Aws::S3Control::Model::ListJobsRequest::WithAccountId ( const char *  value)
inline

Definition at line 83 of file ListJobsRequest.h.

◆ WithJobStatuses() [1/2]

ListJobsRequest& Aws::S3Control::Model::ListJobsRequest::WithJobStatuses ( const Aws::Vector< JobStatus > &  value)
inline

The List Jobs request returns jobs that match the statuses listed in this element.

Definition at line 114 of file ListJobsRequest.h.

◆ WithJobStatuses() [2/2]

ListJobsRequest& Aws::S3Control::Model::ListJobsRequest::WithJobStatuses ( Aws::Vector< JobStatus > &&  value)
inline

The List Jobs request returns jobs that match the statuses listed in this element.

Definition at line 120 of file ListJobsRequest.h.

◆ WithMaxResults()

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

The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

Definition at line 230 of file ListJobsRequest.h.

◆ WithNextToken() [1/3]

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

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

Definition at line 181 of file ListJobsRequest.h.

◆ WithNextToken() [2/3]

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

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

Definition at line 189 of file ListJobsRequest.h.

◆ WithNextToken() [3/3]

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

A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

Definition at line 197 of file ListJobsRequest.h.


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