AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::GetResourcesRequest Class Reference

#include <GetResourcesRequest.h>

+ Inheritance diagram for Aws::APIGateway::Model::GetResourcesRequest:

Public Member Functions

 GetResourcesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetRestApiId () const
 
bool RestApiIdHasBeenSet () const
 
void SetRestApiId (const Aws::String &value)
 
void SetRestApiId (Aws::String &&value)
 
void SetRestApiId (const char *value)
 
GetResourcesRequestWithRestApiId (const Aws::String &value)
 
GetResourcesRequestWithRestApiId (Aws::String &&value)
 
GetResourcesRequestWithRestApiId (const char *value)
 
const Aws::StringGetPosition () const
 
bool PositionHasBeenSet () const
 
void SetPosition (const Aws::String &value)
 
void SetPosition (Aws::String &&value)
 
void SetPosition (const char *value)
 
GetResourcesRequestWithPosition (const Aws::String &value)
 
GetResourcesRequestWithPosition (Aws::String &&value)
 
GetResourcesRequestWithPosition (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
GetResourcesRequestWithLimit (int value)
 
const Aws::Vector< Aws::String > & GetEmbed () const
 
bool EmbedHasBeenSet () const
 
void SetEmbed (const Aws::Vector< Aws::String > &value)
 
void SetEmbed (Aws::Vector< Aws::String > &&value)
 
GetResourcesRequestWithEmbed (const Aws::Vector< Aws::String > &value)
 
GetResourcesRequestWithEmbed (Aws::Vector< Aws::String > &&value)
 
GetResourcesRequestAddEmbed (const Aws::String &value)
 
GetResourcesRequestAddEmbed (Aws::String &&value)
 
GetResourcesRequestAddEmbed (const char *value)
 
- Public Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual ~APIGatewayRequest ()
 
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::APIGateway::APIGatewayRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Request to list information about a collection of resources.

See Also:

AWS API Reference

Definition at line 30 of file GetResourcesRequest.h.

Constructor & Destructor Documentation

◆ GetResourcesRequest()

Aws::APIGateway::Model::GetResourcesRequest::GetResourcesRequest ( )

Member Function Documentation

◆ AddEmbed() [1/3]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::AddEmbed ( const Aws::String value)
inline

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Definition at line 228 of file GetResourcesRequest.h.

◆ AddEmbed() [2/3]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::AddEmbed ( Aws::String &&  value)
inline

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Definition at line 239 of file GetResourcesRequest.h.

◆ AddEmbed() [3/3]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::AddEmbed ( const char *  value)
inline

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Definition at line 250 of file GetResourcesRequest.h.

◆ AddQueryStringParameters()

void Aws::APIGateway::Model::GetResourcesRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EmbedHasBeenSet()

bool Aws::APIGateway::Model::GetResourcesRequest::EmbedHasBeenSet ( ) const
inline

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Definition at line 173 of file GetResourcesRequest.h.

◆ GetEmbed()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::GetResourcesRequest::GetEmbed ( ) const
inline

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Definition at line 162 of file GetResourcesRequest.h.

◆ GetLimit()

int Aws::APIGateway::Model::GetResourcesRequest::GetLimit ( ) const
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 132 of file GetResourcesRequest.h.

◆ GetPosition()

const Aws::String& Aws::APIGateway::Model::GetResourcesRequest::GetPosition ( ) const
inline

The current pagination position in the paged result set.

Definition at line 90 of file GetResourcesRequest.h.

◆ GetRestApiId()

const Aws::String& Aws::APIGateway::Model::GetResourcesRequest::GetRestApiId ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 49 of file GetResourcesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::APIGateway::Model::GetResourcesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file GetResourcesRequest.h.

◆ LimitHasBeenSet()

bool Aws::APIGateway::Model::GetResourcesRequest::LimitHasBeenSet ( ) const
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 138 of file GetResourcesRequest.h.

◆ PositionHasBeenSet()

bool Aws::APIGateway::Model::GetResourcesRequest::PositionHasBeenSet ( ) const
inline

The current pagination position in the paged result set.

Definition at line 95 of file GetResourcesRequest.h.

◆ RestApiIdHasBeenSet()

bool Aws::APIGateway::Model::GetResourcesRequest::RestApiIdHasBeenSet ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 54 of file GetResourcesRequest.h.

◆ SerializePayload()

Aws::String Aws::APIGateway::Model::GetResourcesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEmbed() [1/2]

void Aws::APIGateway::Model::GetResourcesRequest::SetEmbed ( const Aws::Vector< Aws::String > &  value)
inline

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Definition at line 184 of file GetResourcesRequest.h.

◆ SetEmbed() [2/2]

void Aws::APIGateway::Model::GetResourcesRequest::SetEmbed ( Aws::Vector< Aws::String > &&  value)
inline

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Definition at line 195 of file GetResourcesRequest.h.

◆ SetLimit()

void Aws::APIGateway::Model::GetResourcesRequest::SetLimit ( int  value)
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 144 of file GetResourcesRequest.h.

◆ SetPosition() [1/3]

void Aws::APIGateway::Model::GetResourcesRequest::SetPosition ( const Aws::String value)
inline

The current pagination position in the paged result set.

Definition at line 100 of file GetResourcesRequest.h.

◆ SetPosition() [2/3]

void Aws::APIGateway::Model::GetResourcesRequest::SetPosition ( Aws::String &&  value)
inline

The current pagination position in the paged result set.

Definition at line 105 of file GetResourcesRequest.h.

◆ SetPosition() [3/3]

void Aws::APIGateway::Model::GetResourcesRequest::SetPosition ( const char *  value)
inline

The current pagination position in the paged result set.

Definition at line 110 of file GetResourcesRequest.h.

◆ SetRestApiId() [1/3]

void Aws::APIGateway::Model::GetResourcesRequest::SetRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 59 of file GetResourcesRequest.h.

◆ SetRestApiId() [2/3]

void Aws::APIGateway::Model::GetResourcesRequest::SetRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 64 of file GetResourcesRequest.h.

◆ SetRestApiId() [3/3]

void Aws::APIGateway::Model::GetResourcesRequest::SetRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 69 of file GetResourcesRequest.h.

◆ WithEmbed() [1/2]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::WithEmbed ( const Aws::Vector< Aws::String > &  value)
inline

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Definition at line 206 of file GetResourcesRequest.h.

◆ WithEmbed() [2/2]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::WithEmbed ( Aws::Vector< Aws::String > &&  value)
inline

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

Definition at line 217 of file GetResourcesRequest.h.

◆ WithLimit()

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::WithLimit ( int  value)
inline

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Definition at line 150 of file GetResourcesRequest.h.

◆ WithPosition() [1/3]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::WithPosition ( const Aws::String value)
inline

The current pagination position in the paged result set.

Definition at line 115 of file GetResourcesRequest.h.

◆ WithPosition() [2/3]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::WithPosition ( Aws::String &&  value)
inline

The current pagination position in the paged result set.

Definition at line 120 of file GetResourcesRequest.h.

◆ WithPosition() [3/3]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::WithPosition ( const char *  value)
inline

The current pagination position in the paged result set.

Definition at line 125 of file GetResourcesRequest.h.

◆ WithRestApiId() [1/3]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::WithRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 74 of file GetResourcesRequest.h.

◆ WithRestApiId() [2/3]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::WithRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 79 of file GetResourcesRequest.h.

◆ WithRestApiId() [3/3]

GetResourcesRequest& Aws::APIGateway::Model::GetResourcesRequest::WithRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 84 of file GetResourcesRequest.h.


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