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

A POST request to import an API to API Gateway using an input of an API * definition file.

See Also:

AWS * API Reference

*/ class ImportRestApiRequest : public StreamingAPIGatewayRequest { public: AWS_APIGATEWAY_API ImportRestApiRequest(); // 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 "ImportRestApi"; } AWS_APIGATEWAY_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

A query parameter to indicate whether to rollback the API creation * (true) or not (false) when a warning is encountered. * The default value is false.

*/ inline bool GetFailOnWarnings() const{ return m_failOnWarnings; } /** *

A query parameter to indicate whether to rollback the API creation * (true) or not (false) when a warning is encountered. * The default value is false.

*/ inline bool FailOnWarningsHasBeenSet() const { return m_failOnWarningsHasBeenSet; } /** *

A query parameter to indicate whether to rollback the API creation * (true) or not (false) when a warning is encountered. * The default value is false.

*/ inline void SetFailOnWarnings(bool value) { m_failOnWarningsHasBeenSet = true; m_failOnWarnings = value; } /** *

A query parameter to indicate whether to rollback the API creation * (true) or not (false) when a warning is encountered. * The default value is false.

*/ inline ImportRestApiRequest& WithFailOnWarnings(bool value) { SetFailOnWarnings(value); return *this;} /** *

A key-value map of context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

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

A key-value map of context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

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

A key-value map of context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

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

A key-value map of context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

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

A key-value map of context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

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

A key-value map of context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

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

A key-value map of context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

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

A key-value map of context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

*/ inline ImportRestApiRequest& 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 context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

*/ inline ImportRestApiRequest& 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 context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

*/ inline ImportRestApiRequest& 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 context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

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

A key-value map of context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

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

A key-value map of context-specific query string parameters specifying the * behavior of different API importing operations. The following shows * operation-specific parameters and their supported values.

To exclude * DocumentationParts from the import, set parameters as * ignore=documentation.

To configure the endpoint type, set * parameters as endpointConfigurationTypes=EDGE, * endpointConfigurationTypes=REGIONAL, or * endpointConfigurationTypes=PRIVATE. The default endpoint type is * EDGE.

To handle imported basepath, set * parameters as basepath=ignore, * basepath=prepend or basepath=split.

For * example, the AWS CLI command to exclude documentation from the imported API * is:

The AWS CLI command to set the regional endpoint on the imported API * is:

*/ inline ImportRestApiRequest& AddParameters(const char* key, const char* value) { m_parametersHasBeenSet = true; m_parameters.emplace(key, value); return *this; } private: bool m_failOnWarnings; bool m_failOnWarningsHasBeenSet = false; Aws::Map m_parameters; bool m_parametersHasBeenSet = false; }; } // namespace Model } // namespace APIGateway } // namespace Aws