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

#include <GetDeploymentRequest.h>

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

Public Member Functions

 GetDeploymentRequest ()
 
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)
 
GetDeploymentRequestWithRestApiId (const Aws::String &value)
 
GetDeploymentRequestWithRestApiId (Aws::String &&value)
 
GetDeploymentRequestWithRestApiId (const char *value)
 
const Aws::StringGetDeploymentId () const
 
bool DeploymentIdHasBeenSet () const
 
void SetDeploymentId (const Aws::String &value)
 
void SetDeploymentId (Aws::String &&value)
 
void SetDeploymentId (const char *value)
 
GetDeploymentRequestWithDeploymentId (const Aws::String &value)
 
GetDeploymentRequestWithDeploymentId (Aws::String &&value)
 
GetDeploymentRequestWithDeploymentId (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)
 
GetDeploymentRequestWithEmbed (const Aws::Vector< Aws::String > &value)
 
GetDeploymentRequestWithEmbed (Aws::Vector< Aws::String > &&value)
 
GetDeploymentRequestAddEmbed (const Aws::String &value)
 
GetDeploymentRequestAddEmbed (Aws::String &&value)
 
GetDeploymentRequestAddEmbed (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

Requests API Gateway to get information about a Deployment resource.

See Also:

AWS API Reference

Definition at line 30 of file GetDeploymentRequest.h.

Constructor & Destructor Documentation

◆ GetDeploymentRequest()

Aws::APIGateway::Model::GetDeploymentRequest::GetDeploymentRequest ( )

Member Function Documentation

◆ AddEmbed() [1/3]

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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Definition at line 232 of file GetDeploymentRequest.h.

◆ AddEmbed() [2/3]

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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Definition at line 246 of file GetDeploymentRequest.h.

◆ AddEmbed() [3/3]

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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Definition at line 260 of file GetDeploymentRequest.h.

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ DeploymentIdHasBeenSet()

bool Aws::APIGateway::Model::GetDeploymentRequest::DeploymentIdHasBeenSet ( ) const
inline

[Required] The identifier of the Deployment resource to get information about.

Definition at line 97 of file GetDeploymentRequest.h.

◆ EmbedHasBeenSet()

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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Definition at line 162 of file GetDeploymentRequest.h.

◆ GetDeploymentId()

const Aws::String& Aws::APIGateway::Model::GetDeploymentRequest::GetDeploymentId ( ) const
inline

[Required] The identifier of the Deployment resource to get information about.

Definition at line 91 of file GetDeploymentRequest.h.

◆ GetEmbed()

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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Definition at line 148 of file GetDeploymentRequest.h.

◆ GetRestApiId()

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

[Required] The string identifier of the associated RestApi.

Definition at line 49 of file GetDeploymentRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file GetDeploymentRequest.h.

◆ RestApiIdHasBeenSet()

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

[Required] The string identifier of the associated RestApi.

Definition at line 54 of file GetDeploymentRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDeploymentId() [1/3]

void Aws::APIGateway::Model::GetDeploymentRequest::SetDeploymentId ( const Aws::String value)
inline

[Required] The identifier of the Deployment resource to get information about.

Definition at line 103 of file GetDeploymentRequest.h.

◆ SetDeploymentId() [2/3]

void Aws::APIGateway::Model::GetDeploymentRequest::SetDeploymentId ( Aws::String &&  value)
inline

[Required] The identifier of the Deployment resource to get information about.

Definition at line 109 of file GetDeploymentRequest.h.

◆ SetDeploymentId() [3/3]

void Aws::APIGateway::Model::GetDeploymentRequest::SetDeploymentId ( const char *  value)
inline

[Required] The identifier of the Deployment resource to get information about.

Definition at line 115 of file GetDeploymentRequest.h.

◆ SetEmbed() [1/2]

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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Definition at line 176 of file GetDeploymentRequest.h.

◆ SetEmbed() [2/2]

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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Definition at line 190 of file GetDeploymentRequest.h.

◆ SetRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 59 of file GetDeploymentRequest.h.

◆ SetRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 64 of file GetDeploymentRequest.h.

◆ SetRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 69 of file GetDeploymentRequest.h.

◆ WithDeploymentId() [1/3]

GetDeploymentRequest& Aws::APIGateway::Model::GetDeploymentRequest::WithDeploymentId ( const Aws::String value)
inline

[Required] The identifier of the Deployment resource to get information about.

Definition at line 121 of file GetDeploymentRequest.h.

◆ WithDeploymentId() [2/3]

GetDeploymentRequest& Aws::APIGateway::Model::GetDeploymentRequest::WithDeploymentId ( Aws::String &&  value)
inline

[Required] The identifier of the Deployment resource to get information about.

Definition at line 127 of file GetDeploymentRequest.h.

◆ WithDeploymentId() [3/3]

GetDeploymentRequest& Aws::APIGateway::Model::GetDeploymentRequest::WithDeploymentId ( const char *  value)
inline

[Required] The identifier of the Deployment resource to get information about.

Definition at line 133 of file GetDeploymentRequest.h.

◆ WithEmbed() [1/2]

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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Definition at line 204 of file GetDeploymentRequest.h.

◆ WithEmbed() [2/2]

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

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

Definition at line 218 of file GetDeploymentRequest.h.

◆ WithRestApiId() [1/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 74 of file GetDeploymentRequest.h.

◆ WithRestApiId() [2/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 79 of file GetDeploymentRequest.h.

◆ WithRestApiId() [3/3]

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

[Required] The string identifier of the associated RestApi.

Definition at line 84 of file GetDeploymentRequest.h.


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