/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace APIGateway { namespace Model { /** *

Requests API Gateway to get information about a Deployment * resource.

See Also:

AWS * API Reference

*/ class GetDeploymentRequest : public APIGatewayRequest { public: AWS_APIGATEWAY_API GetDeploymentRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "GetDeployment"; } AWS_APIGATEWAY_API Aws::String SerializePayload() const override; AWS_APIGATEWAY_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

The string identifier of the associated RestApi.

*/ inline const Aws::String& GetRestApiId() const{ return m_restApiId; } /** *

The string identifier of the associated RestApi.

*/ inline bool RestApiIdHasBeenSet() const { return m_restApiIdHasBeenSet; } /** *

The string identifier of the associated RestApi.

*/ inline void SetRestApiId(const Aws::String& value) { m_restApiIdHasBeenSet = true; m_restApiId = value; } /** *

The string identifier of the associated RestApi.

*/ inline void SetRestApiId(Aws::String&& value) { m_restApiIdHasBeenSet = true; m_restApiId = std::move(value); } /** *

The string identifier of the associated RestApi.

*/ inline void SetRestApiId(const char* value) { m_restApiIdHasBeenSet = true; m_restApiId.assign(value); } /** *

The string identifier of the associated RestApi.

*/ inline GetDeploymentRequest& WithRestApiId(const Aws::String& value) { SetRestApiId(value); return *this;} /** *

The string identifier of the associated RestApi.

*/ inline GetDeploymentRequest& WithRestApiId(Aws::String&& value) { SetRestApiId(std::move(value)); return *this;} /** *

The string identifier of the associated RestApi.

*/ inline GetDeploymentRequest& WithRestApiId(const char* value) { SetRestApiId(value); return *this;} /** *

The identifier of the Deployment resource to get information about.

*/ inline const Aws::String& GetDeploymentId() const{ return m_deploymentId; } /** *

The identifier of the Deployment resource to get information about.

*/ inline bool DeploymentIdHasBeenSet() const { return m_deploymentIdHasBeenSet; } /** *

The identifier of the Deployment resource to get information about.

*/ inline void SetDeploymentId(const Aws::String& value) { m_deploymentIdHasBeenSet = true; m_deploymentId = value; } /** *

The identifier of the Deployment resource to get information about.

*/ inline void SetDeploymentId(Aws::String&& value) { m_deploymentIdHasBeenSet = true; m_deploymentId = std::move(value); } /** *

The identifier of the Deployment resource to get information about.

*/ inline void SetDeploymentId(const char* value) { m_deploymentIdHasBeenSet = true; m_deploymentId.assign(value); } /** *

The identifier of the Deployment resource to get information about.

*/ inline GetDeploymentRequest& WithDeploymentId(const Aws::String& value) { SetDeploymentId(value); return *this;} /** *

The identifier of the Deployment resource to get information about.

*/ inline GetDeploymentRequest& WithDeploymentId(Aws::String&& value) { SetDeploymentId(std::move(value)); return *this;} /** *

The identifier of the Deployment resource to get information about.

*/ inline GetDeploymentRequest& WithDeploymentId(const char* value) { SetDeploymentId(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetEmbed() const{ return m_embed; } /** *

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.

*/ inline bool EmbedHasBeenSet() const { return m_embedHasBeenSet; } /** *

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.

*/ inline void SetEmbed(const Aws::Vector& value) { m_embedHasBeenSet = true; m_embed = value; } /** *

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.

*/ inline void SetEmbed(Aws::Vector&& value) { m_embedHasBeenSet = true; m_embed = std::move(value); } /** *

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.

*/ inline GetDeploymentRequest& WithEmbed(const Aws::Vector& value) { SetEmbed(value); return *this;} /** *

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.

*/ inline GetDeploymentRequest& WithEmbed(Aws::Vector&& value) { SetEmbed(std::move(value)); return *this;} /** *

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.

*/ inline GetDeploymentRequest& AddEmbed(const Aws::String& value) { m_embedHasBeenSet = true; m_embed.push_back(value); return *this; } /** *

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.

*/ inline GetDeploymentRequest& AddEmbed(Aws::String&& value) { m_embedHasBeenSet = true; m_embed.push_back(std::move(value)); return *this; } /** *

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.

*/ inline GetDeploymentRequest& AddEmbed(const char* value) { m_embedHasBeenSet = true; m_embed.push_back(value); return *this; } private: Aws::String m_restApiId; bool m_restApiIdHasBeenSet = false; Aws::String m_deploymentId; bool m_deploymentIdHasBeenSet = false; Aws::Vector m_embed; bool m_embedHasBeenSet = false; }; } // namespace Model } // namespace APIGateway } // namespace Aws