/** * 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 { /** *

Request a new export of a RestApi for a particular Stage.

See * Also:

AWS * API Reference

*/ class GetExportRequest : public APIGatewayRequest { public: AWS_APIGATEWAY_API GetExportRequest(); // 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 "GetExport"; } AWS_APIGATEWAY_API Aws::String SerializePayload() const override; AWS_APIGATEWAY_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; AWS_APIGATEWAY_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() 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 GetExportRequest& WithRestApiId(const Aws::String& value) { SetRestApiId(value); return *this;} /** *

The string identifier of the associated RestApi.

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

The string identifier of the associated RestApi.

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

The name of the Stage that will be exported.

*/ inline const Aws::String& GetStageName() const{ return m_stageName; } /** *

The name of the Stage that will be exported.

*/ inline bool StageNameHasBeenSet() const { return m_stageNameHasBeenSet; } /** *

The name of the Stage that will be exported.

*/ inline void SetStageName(const Aws::String& value) { m_stageNameHasBeenSet = true; m_stageName = value; } /** *

The name of the Stage that will be exported.

*/ inline void SetStageName(Aws::String&& value) { m_stageNameHasBeenSet = true; m_stageName = std::move(value); } /** *

The name of the Stage that will be exported.

*/ inline void SetStageName(const char* value) { m_stageNameHasBeenSet = true; m_stageName.assign(value); } /** *

The name of the Stage that will be exported.

*/ inline GetExportRequest& WithStageName(const Aws::String& value) { SetStageName(value); return *this;} /** *

The name of the Stage that will be exported.

*/ inline GetExportRequest& WithStageName(Aws::String&& value) { SetStageName(std::move(value)); return *this;} /** *

The name of the Stage that will be exported.

*/ inline GetExportRequest& WithStageName(const char* value) { SetStageName(value); return *this;} /** *

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and * 'swagger' for Swagger/OpenAPI 2.0.

*/ inline const Aws::String& GetExportType() const{ return m_exportType; } /** *

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and * 'swagger' for Swagger/OpenAPI 2.0.

*/ inline bool ExportTypeHasBeenSet() const { return m_exportTypeHasBeenSet; } /** *

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and * 'swagger' for Swagger/OpenAPI 2.0.

*/ inline void SetExportType(const Aws::String& value) { m_exportTypeHasBeenSet = true; m_exportType = value; } /** *

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and * 'swagger' for Swagger/OpenAPI 2.0.

*/ inline void SetExportType(Aws::String&& value) { m_exportTypeHasBeenSet = true; m_exportType = std::move(value); } /** *

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and * 'swagger' for Swagger/OpenAPI 2.0.

*/ inline void SetExportType(const char* value) { m_exportTypeHasBeenSet = true; m_exportType.assign(value); } /** *

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and * 'swagger' for Swagger/OpenAPI 2.0.

*/ inline GetExportRequest& WithExportType(const Aws::String& value) { SetExportType(value); return *this;} /** *

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and * 'swagger' for Swagger/OpenAPI 2.0.

*/ inline GetExportRequest& WithExportType(Aws::String&& value) { SetExportType(std::move(value)); return *this;} /** *

The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and * 'swagger' for Swagger/OpenAPI 2.0.

*/ inline GetExportRequest& WithExportType(const char* value) { SetExportType(value); return *this;} /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline const Aws::Map& GetParameters() const{ return m_parameters; } /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; } /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline void SetParameters(const Aws::Map& value) { m_parametersHasBeenSet = true; m_parameters = value; } /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline void SetParameters(Aws::Map&& value) { m_parametersHasBeenSet = true; m_parameters = std::move(value); } /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline GetExportRequest& WithParameters(const Aws::Map& value) { SetParameters(value); return *this;} /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline GetExportRequest& WithParameters(Aws::Map&& value) { SetParameters(std::move(value)); return *this;} /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline GetExportRequest& AddParameters(const Aws::String& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline GetExportRequest& AddParameters(Aws::String&& key, const Aws::String& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; } /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline GetExportRequest& AddParameters(const Aws::String& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; } /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline GetExportRequest& AddParameters(Aws::String&& key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), std::move(value)); return *this; } /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline GetExportRequest& AddParameters(const char* key, Aws::String&& value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, std::move(value)); return *this; } /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline GetExportRequest& AddParameters(Aws::String&& key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(std::move(key), value); return *this; } /** *

A key-value map of query string parameters that specify properties of the * export, depending on the requested exportType. For * exportType oas30 and swagger, any * combination of the following parameters are supported: * extensions='integrations' or extensions='apigateway' * will export the API with x-amazon-apigateway-integration extensions. * extensions='authorizers' will export the API with * x-amazon-apigateway-authorizer extensions. postman will export the * API with Postman extensions, allowing for import to the Postman tool

*/ inline GetExportRequest& AddParameters(const char* key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } /** *

The content-type of the export, for example application/json. * Currently application/json and application/yaml are * supported for exportType ofoas30 and * swagger. This should be specified in the Accept header * for direct API requests.

*/ inline const Aws::String& GetAccepts() const{ return m_accepts; } /** *

The content-type of the export, for example application/json. * Currently application/json and application/yaml are * supported for exportType ofoas30 and * swagger. This should be specified in the Accept header * for direct API requests.

*/ inline bool AcceptsHasBeenSet() const { return m_acceptsHasBeenSet; } /** *

The content-type of the export, for example application/json. * Currently application/json and application/yaml are * supported for exportType ofoas30 and * swagger. This should be specified in the Accept header * for direct API requests.

*/ inline void SetAccepts(const Aws::String& value) { m_acceptsHasBeenSet = true; m_accepts = value; } /** *

The content-type of the export, for example application/json. * Currently application/json and application/yaml are * supported for exportType ofoas30 and * swagger. This should be specified in the Accept header * for direct API requests.

*/ inline void SetAccepts(Aws::String&& value) { m_acceptsHasBeenSet = true; m_accepts = std::move(value); } /** *

The content-type of the export, for example application/json. * Currently application/json and application/yaml are * supported for exportType ofoas30 and * swagger. This should be specified in the Accept header * for direct API requests.

*/ inline void SetAccepts(const char* value) { m_acceptsHasBeenSet = true; m_accepts.assign(value); } /** *

The content-type of the export, for example application/json. * Currently application/json and application/yaml are * supported for exportType ofoas30 and * swagger. This should be specified in the Accept header * for direct API requests.

*/ inline GetExportRequest& WithAccepts(const Aws::String& value) { SetAccepts(value); return *this;} /** *

The content-type of the export, for example application/json. * Currently application/json and application/yaml are * supported for exportType ofoas30 and * swagger. This should be specified in the Accept header * for direct API requests.

*/ inline GetExportRequest& WithAccepts(Aws::String&& value) { SetAccepts(std::move(value)); return *this;} /** *

The content-type of the export, for example application/json. * Currently application/json and application/yaml are * supported for exportType ofoas30 and * swagger. This should be specified in the Accept header * for direct API requests.

*/ inline GetExportRequest& WithAccepts(const char* value) { SetAccepts(value); return *this;} private: Aws::String m_restApiId; bool m_restApiIdHasBeenSet = false; Aws::String m_stageName; bool m_stageNameHasBeenSet = false; Aws::String m_exportType; bool m_exportTypeHasBeenSet = false; Aws::Map m_parameters; bool m_parametersHasBeenSet = false; Aws::String m_accepts; bool m_acceptsHasBeenSet = false; }; } // namespace Model } // namespace APIGateway } // namespace Aws