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

#include <ListWorldsRequest.h>

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

Public Member Functions

 ListWorldsRequest ()
 
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)
 
ListWorldsRequestWithNextToken (const Aws::String &value)
 
ListWorldsRequestWithNextToken (Aws::String &&value)
 
ListWorldsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListWorldsRequestWithMaxResults (int value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
ListWorldsRequestWithFilters (const Aws::Vector< Filter > &value)
 
ListWorldsRequestWithFilters (Aws::Vector< Filter > &&value)
 
ListWorldsRequestAddFilters (const Filter &value)
 
ListWorldsRequestAddFilters (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 ListWorldsRequest.h.

Constructor & Destructor Documentation

◆ ListWorldsRequest()

Aws::RoboMaker::Model::ListWorldsRequest::ListWorldsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

Optional filters to limit results. You can use status.

Definition at line 196 of file ListWorldsRequest.h.

◆ AddFilters() [2/2]

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

Optional filters to limit results. You can use status.

Definition at line 201 of file ListWorldsRequest.h.

◆ FiltersHasBeenSet()

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

Optional filters to limit results. You can use status.

Definition at line 171 of file ListWorldsRequest.h.

◆ GetFilters()

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

Optional filters to limit results. You can use status.

Definition at line 166 of file ListWorldsRequest.h.

◆ GetMaxResults()

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

When this parameter is used, ListWorlds 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 ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

Definition at line 127 of file ListWorldsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::RoboMaker::Model::ListWorldsRequest::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 ListWorlds 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 ListWorldsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListWorldsRequest.h.

◆ MaxResultsHasBeenSet()

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

When this parameter is used, ListWorlds 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 ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

Definition at line 138 of file ListWorldsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::RoboMaker::Model::ListWorldsRequest::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 ListWorlds 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 ListWorldsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

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

Optional filters to limit results. You can use status.

Definition at line 176 of file ListWorldsRequest.h.

◆ SetFilters() [2/2]

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

Optional filters to limit results. You can use status.

Definition at line 181 of file ListWorldsRequest.h.

◆ SetMaxResults()

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

When this parameter is used, ListWorlds 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 ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

Definition at line 149 of file ListWorldsRequest.h.

◆ SetNextToken() [1/3]

void Aws::RoboMaker::Model::ListWorldsRequest::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 ListWorlds 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 ListWorldsRequest.h.

◆ SetNextToken() [2/3]

void Aws::RoboMaker::Model::ListWorldsRequest::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 ListWorlds 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 ListWorldsRequest.h.

◆ SetNextToken() [3/3]

void Aws::RoboMaker::Model::ListWorldsRequest::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 ListWorlds 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 ListWorldsRequest.h.

◆ WithFilters() [1/2]

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

Optional filters to limit results. You can use status.

Definition at line 186 of file ListWorldsRequest.h.

◆ WithFilters() [2/2]

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

Optional filters to limit results. You can use status.

Definition at line 191 of file ListWorldsRequest.h.

◆ WithMaxResults()

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

When this parameter is used, ListWorlds 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 ListWorlds request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListWorlds returns up to 100 results and a nextToken value if applicable.

Definition at line 160 of file ListWorldsRequest.h.

◆ WithNextToken() [1/3]

ListWorldsRequest& Aws::RoboMaker::Model::ListWorldsRequest::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 ListWorlds 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 ListWorldsRequest.h.

◆ WithNextToken() [2/3]

ListWorldsRequest& Aws::RoboMaker::Model::ListWorldsRequest::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 ListWorlds 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 ListWorldsRequest.h.

◆ WithNextToken() [3/3]

ListWorldsRequest& Aws::RoboMaker::Model::ListWorldsRequest::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 ListWorlds 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 ListWorldsRequest.h.


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