AWS SDK for C++  1.8.99
AWS SDK for C++
Public Member Functions | List of all members
Aws::RoboMaker::Model::ListSimulationJobsRequest Class Reference

#include <ListSimulationJobsRequest.h>

+ Inheritance diagram for Aws::RoboMaker::Model::ListSimulationJobsRequest:

Public Member Functions

 ListSimulationJobsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListSimulationJobsRequestWithNextToken (const Aws::String &value)
 
ListSimulationJobsRequestWithNextToken (Aws::String &&value)
 
ListSimulationJobsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListSimulationJobsRequestWithMaxResults (int value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
ListSimulationJobsRequestWithFilters (const Aws::Vector< Filter > &value)
 
ListSimulationJobsRequestWithFilters (Aws::Vector< Filter > &&value)
 
ListSimulationJobsRequestAddFilters (const Filter &value)
 
ListSimulationJobsRequestAddFilters (Filter &&value)
 
- Public Member Functions inherited from Aws::RoboMaker::RoboMakerRequest
virtual ~RoboMakerRequest ()
 
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::RoboMaker::RoboMakerRequest
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 23 of file ListSimulationJobsRequest.h.

Constructor & Destructor Documentation

◆ ListSimulationJobsRequest()

Aws::RoboMaker::Model::ListSimulationJobsRequest::ListSimulationJobsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

ListSimulationJobsRequest& Aws::RoboMaker::Model::ListSimulationJobsRequest::AddFilters ( const Filter value)
inline

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

Definition at line 235 of file ListSimulationJobsRequest.h.

◆ AddFilters() [2/2]

ListSimulationJobsRequest& Aws::RoboMaker::Model::ListSimulationJobsRequest::AddFilters ( Filter &&  value)
inline

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

Definition at line 245 of file ListSimulationJobsRequest.h.

◆ FiltersHasBeenSet()

bool Aws::RoboMaker::Model::ListSimulationJobsRequest::FiltersHasBeenSet ( ) const
inline

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

Definition at line 185 of file ListSimulationJobsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::RoboMaker::Model::ListSimulationJobsRequest::GetFilters ( ) const
inline

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

Definition at line 175 of file ListSimulationJobsRequest.h.

◆ GetMaxResults()

int Aws::RoboMaker::Model::ListSimulationJobsRequest::GetMaxResults ( ) const
inline

When this parameter is used, ListSimulationJobs 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 ListSimulationJobs request with the returned nextToken value. This value can be between 1 and

  1. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable.

Definition at line 128 of file ListSimulationJobsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::RoboMaker::Model::ListSimulationJobsRequest::GetNextToken ( ) const
inline

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 45 of file ListSimulationJobsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::RoboMaker::Model::ListSimulationJobsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListSimulationJobsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::RoboMaker::Model::ListSimulationJobsRequest::MaxResultsHasBeenSet ( ) const
inline

When this parameter is used, ListSimulationJobs 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 ListSimulationJobs request with the returned nextToken value. This value can be between 1 and

  1. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable.

Definition at line 140 of file ListSimulationJobsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::RoboMaker::Model::ListSimulationJobsRequest::NextTokenHasBeenSet ( ) const
inline

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 55 of file ListSimulationJobsRequest.h.

◆ SerializePayload()

Aws::String Aws::RoboMaker::Model::ListSimulationJobsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::RoboMaker::Model::ListSimulationJobsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

Definition at line 195 of file ListSimulationJobsRequest.h.

◆ SetFilters() [2/2]

void Aws::RoboMaker::Model::ListSimulationJobsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

Definition at line 205 of file ListSimulationJobsRequest.h.

◆ SetMaxResults()

void Aws::RoboMaker::Model::ListSimulationJobsRequest::SetMaxResults ( int  value)
inline

When this parameter is used, ListSimulationJobs 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 ListSimulationJobs request with the returned nextToken value. This value can be between 1 and

  1. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable.

Definition at line 152 of file ListSimulationJobsRequest.h.

◆ SetNextToken() [1/3]

void Aws::RoboMaker::Model::ListSimulationJobsRequest::SetNextToken ( const Aws::String value)
inline

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 65 of file ListSimulationJobsRequest.h.

◆ SetNextToken() [2/3]

void Aws::RoboMaker::Model::ListSimulationJobsRequest::SetNextToken ( Aws::String &&  value)
inline

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 75 of file ListSimulationJobsRequest.h.

◆ SetNextToken() [3/3]

void Aws::RoboMaker::Model::ListSimulationJobsRequest::SetNextToken ( const char *  value)
inline

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 85 of file ListSimulationJobsRequest.h.

◆ WithFilters() [1/2]

ListSimulationJobsRequest& Aws::RoboMaker::Model::ListSimulationJobsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

Definition at line 215 of file ListSimulationJobsRequest.h.

◆ WithFilters() [2/2]

ListSimulationJobsRequest& Aws::RoboMaker::Model::ListSimulationJobsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

Optional filters to limit results.

The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

Definition at line 225 of file ListSimulationJobsRequest.h.

◆ WithMaxResults()

ListSimulationJobsRequest& Aws::RoboMaker::Model::ListSimulationJobsRequest::WithMaxResults ( int  value)
inline

When this parameter is used, ListSimulationJobs 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 ListSimulationJobs request with the returned nextToken value. This value can be between 1 and

  1. If this parameter is not used, then ListSimulationJobs returns up to 1000 results and a nextToken value if applicable.

Definition at line 164 of file ListSimulationJobsRequest.h.

◆ WithNextToken() [1/3]

ListSimulationJobsRequest& Aws::RoboMaker::Model::ListSimulationJobsRequest::WithNextToken ( const Aws::String value)
inline

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 95 of file ListSimulationJobsRequest.h.

◆ WithNextToken() [2/3]

ListSimulationJobsRequest& Aws::RoboMaker::Model::ListSimulationJobsRequest::WithNextToken ( Aws::String &&  value)
inline

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 105 of file ListSimulationJobsRequest.h.

◆ WithNextToken() [3/3]

ListSimulationJobsRequest& Aws::RoboMaker::Model::ListSimulationJobsRequest::WithNextToken ( const char *  value)
inline

If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Definition at line 115 of file ListSimulationJobsRequest.h.


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