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

#include <GetResourceRequest.h>

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

Public Member Functions

 GetResourceRequest ()
 
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)
 
GetResourceRequestWithRestApiId (const Aws::String &value)
 
GetResourceRequestWithRestApiId (Aws::String &&value)
 
GetResourceRequestWithRestApiId (const char *value)
 
const Aws::StringGetResourceId () const
 
bool ResourceIdHasBeenSet () const
 
void SetResourceId (const Aws::String &value)
 
void SetResourceId (Aws::String &&value)
 
void SetResourceId (const char *value)
 
GetResourceRequestWithResourceId (const Aws::String &value)
 
GetResourceRequestWithResourceId (Aws::String &&value)
 
GetResourceRequestWithResourceId (const char *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)
 
GetResourceRequestWithEmbed (const Aws::Vector< Aws::String > &value)
 
GetResourceRequestWithEmbed (Aws::Vector< Aws::String > &&value)
 
GetResourceRequestAddEmbed (const Aws::String &value)
 
GetResourceRequestAddEmbed (Aws::String &&value)
 
GetResourceRequestAddEmbed (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 resource.

See Also:

AWS API Reference

Definition at line 29 of file GetResourceRequest.h.

Constructor & Destructor Documentation

◆ GetResourceRequest()

Aws::APIGateway::Model::GetResourceRequest::GetResourceRequest ( )

Member Function Documentation

◆ AddEmbed() [1/3]

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

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Definition at line 213 of file GetResourceRequest.h.

◆ AddEmbed() [2/3]

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

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Definition at line 202 of file GetResourceRequest.h.

◆ AddEmbed() [3/3]

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

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Definition at line 224 of file GetResourceRequest.h.

◆ AddQueryStringParameters()

void Aws::APIGateway::Model::GetResourceRequest::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::GetResourceRequest::EmbedHasBeenSet ( ) const
inline

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Definition at line 147 of file GetResourceRequest.h.

◆ GetEmbed()

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

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Definition at line 136 of file GetResourceRequest.h.

◆ GetResourceId()

const Aws::String& Aws::APIGateway::Model::GetResourceRequest::GetResourceId ( ) const
inline

[Required] The identifier for the Resource resource.

Definition at line 89 of file GetResourceRequest.h.

◆ GetRestApiId()

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

[Required] The string identifier of the associated RestApi.

Definition at line 48 of file GetResourceRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file GetResourceRequest.h.

◆ ResourceIdHasBeenSet()

bool Aws::APIGateway::Model::GetResourceRequest::ResourceIdHasBeenSet ( ) const
inline

[Required] The identifier for the Resource resource.

Definition at line 94 of file GetResourceRequest.h.

◆ RestApiIdHasBeenSet()

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

[Required] The string identifier of the associated RestApi.

Definition at line 53 of file GetResourceRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEmbed() [1/2]

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

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Definition at line 169 of file GetResourceRequest.h.

◆ SetEmbed() [2/2]

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

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Definition at line 158 of file GetResourceRequest.h.

◆ SetResourceId() [1/3]

void Aws::APIGateway::Model::GetResourceRequest::SetResourceId ( Aws::String &&  value)
inline

[Required] The identifier for the Resource resource.

Definition at line 104 of file GetResourceRequest.h.

◆ SetResourceId() [2/3]

void Aws::APIGateway::Model::GetResourceRequest::SetResourceId ( const Aws::String value)
inline

[Required] The identifier for the Resource resource.

Definition at line 99 of file GetResourceRequest.h.

◆ SetResourceId() [3/3]

void Aws::APIGateway::Model::GetResourceRequest::SetResourceId ( const char *  value)
inline

[Required] The identifier for the Resource resource.

Definition at line 109 of file GetResourceRequest.h.

◆ SetRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 63 of file GetResourceRequest.h.

◆ SetRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 58 of file GetResourceRequest.h.

◆ SetRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 68 of file GetResourceRequest.h.

◆ WithEmbed() [1/2]

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

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Definition at line 191 of file GetResourceRequest.h.

◆ WithEmbed() [2/2]

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

A query parameter to retrieve the specified resources embedded in the returned Resource representation 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/{resource_id}?embed=methods.

Definition at line 180 of file GetResourceRequest.h.

◆ WithResourceId() [1/3]

GetResourceRequest& Aws::APIGateway::Model::GetResourceRequest::WithResourceId ( Aws::String &&  value)
inline

[Required] The identifier for the Resource resource.

Definition at line 119 of file GetResourceRequest.h.

◆ WithResourceId() [2/3]

GetResourceRequest& Aws::APIGateway::Model::GetResourceRequest::WithResourceId ( const Aws::String value)
inline

[Required] The identifier for the Resource resource.

Definition at line 114 of file GetResourceRequest.h.

◆ WithResourceId() [3/3]

GetResourceRequest& Aws::APIGateway::Model::GetResourceRequest::WithResourceId ( const char *  value)
inline

[Required] The identifier for the Resource resource.

Definition at line 124 of file GetResourceRequest.h.

◆ WithRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 78 of file GetResourceRequest.h.

◆ WithRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 73 of file GetResourceRequest.h.

◆ WithRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 83 of file GetResourceRequest.h.


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