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

#include <ListRobotsRequest.h>

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

Public Member Functions

 ListRobotsRequest ()
 
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)
 
ListRobotsRequestWithNextToken (const Aws::String &value)
 
ListRobotsRequestWithNextToken (Aws::String &&value)
 
ListRobotsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListRobotsRequestWithMaxResults (int value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
ListRobotsRequestWithFilters (const Aws::Vector< Filter > &value)
 
ListRobotsRequestWithFilters (Aws::Vector< Filter > &&value)
 
ListRobotsRequestAddFilters (const Filter &value)
 
ListRobotsRequestAddFilters (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 ListRobotsRequest.h.

Constructor & Destructor Documentation

◆ ListRobotsRequest()

Aws::RoboMaker::Model::ListRobotsRequest::ListRobotsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

Optional filters to limit results.

The filter names status and fleetName 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 Registered or the status Available.

Definition at line 231 of file ListRobotsRequest.h.

◆ AddFilters() [2/2]

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

Optional filters to limit results.

The filter names status and fleetName 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 Registered or the status Available.

Definition at line 241 of file ListRobotsRequest.h.

◆ FiltersHasBeenSet()

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

Optional filters to limit results.

The filter names status and fleetName 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 Registered or the status Available.

Definition at line 181 of file ListRobotsRequest.h.

◆ GetFilters()

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

Optional filters to limit results.

The filter names status and fleetName 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 Registered or the status Available.

Definition at line 171 of file ListRobotsRequest.h.

◆ GetMaxResults()

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

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

Definition at line 127 of file ListRobotsRequest.h.

◆ GetNextToken()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListRobotsRequest.h.

◆ MaxResultsHasBeenSet()

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

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

Definition at line 138 of file ListRobotsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::RoboMaker::Model::ListRobotsRequest::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 ListRobots 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 ListRobotsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

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

Optional filters to limit results.

The filter names status and fleetName 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 Registered or the status Available.

Definition at line 191 of file ListRobotsRequest.h.

◆ SetFilters() [2/2]

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

Optional filters to limit results.

The filter names status and fleetName 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 Registered or the status Available.

Definition at line 201 of file ListRobotsRequest.h.

◆ SetMaxResults()

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

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

Definition at line 149 of file ListRobotsRequest.h.

◆ SetNextToken() [1/3]

void Aws::RoboMaker::Model::ListRobotsRequest::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 ListRobots 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 ListRobotsRequest.h.

◆ SetNextToken() [2/3]

void Aws::RoboMaker::Model::ListRobotsRequest::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 ListRobots 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 ListRobotsRequest.h.

◆ SetNextToken() [3/3]

void Aws::RoboMaker::Model::ListRobotsRequest::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 ListRobots 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 ListRobotsRequest.h.

◆ WithFilters() [1/2]

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

Optional filters to limit results.

The filter names status and fleetName 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 Registered or the status Available.

Definition at line 211 of file ListRobotsRequest.h.

◆ WithFilters() [2/2]

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

Optional filters to limit results.

The filter names status and fleetName 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 Registered or the status Available.

Definition at line 221 of file ListRobotsRequest.h.

◆ WithMaxResults()

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

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

Definition at line 160 of file ListRobotsRequest.h.

◆ WithNextToken() [1/3]

ListRobotsRequest& Aws::RoboMaker::Model::ListRobotsRequest::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 ListRobots 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 ListRobotsRequest.h.

◆ WithNextToken() [2/3]

ListRobotsRequest& Aws::RoboMaker::Model::ListRobotsRequest::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 ListRobots 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 ListRobotsRequest.h.

◆ WithNextToken() [3/3]

ListRobotsRequest& Aws::RoboMaker::Model::ListRobotsRequest::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 ListRobots 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 ListRobotsRequest.h.


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