/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace ApiGatewayV2 { namespace Model { class ImportApiResult { public: AWS_APIGATEWAYV2_API ImportApiResult(); AWS_APIGATEWAYV2_API ImportApiResult(const Aws::AmazonWebServiceResult& result); AWS_APIGATEWAYV2_API ImportApiResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. * The stage name is typically appended to this URI to form a complete path to a * deployed API stage.

*/ inline const Aws::String& GetApiEndpoint() const{ return m_apiEndpoint; } /** *

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. * The stage name is typically appended to this URI to form a complete path to a * deployed API stage.

*/ inline void SetApiEndpoint(const Aws::String& value) { m_apiEndpoint = value; } /** *

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. * The stage name is typically appended to this URI to form a complete path to a * deployed API stage.

*/ inline void SetApiEndpoint(Aws::String&& value) { m_apiEndpoint = std::move(value); } /** *

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. * The stage name is typically appended to this URI to form a complete path to a * deployed API stage.

*/ inline void SetApiEndpoint(const char* value) { m_apiEndpoint.assign(value); } /** *

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. * The stage name is typically appended to this URI to form a complete path to a * deployed API stage.

*/ inline ImportApiResult& WithApiEndpoint(const Aws::String& value) { SetApiEndpoint(value); return *this;} /** *

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. * The stage name is typically appended to this URI to form a complete path to a * deployed API stage.

*/ inline ImportApiResult& WithApiEndpoint(Aws::String&& value) { SetApiEndpoint(std::move(value)); return *this;} /** *

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. * The stage name is typically appended to this URI to form a complete path to a * deployed API stage.

*/ inline ImportApiResult& WithApiEndpoint(const char* value) { SetApiEndpoint(value); return *this;} /** *

Specifies whether an API is managed by API Gateway. You can't update or * delete a managed API by using API Gateway. A managed API can be deleted only * through the tooling or service that created it.

*/ inline bool GetApiGatewayManaged() const{ return m_apiGatewayManaged; } /** *

Specifies whether an API is managed by API Gateway. You can't update or * delete a managed API by using API Gateway. A managed API can be deleted only * through the tooling or service that created it.

*/ inline void SetApiGatewayManaged(bool value) { m_apiGatewayManaged = value; } /** *

Specifies whether an API is managed by API Gateway. You can't update or * delete a managed API by using API Gateway. A managed API can be deleted only * through the tooling or service that created it.

*/ inline ImportApiResult& WithApiGatewayManaged(bool value) { SetApiGatewayManaged(value); return *this;} /** *

The API ID.

*/ inline const Aws::String& GetApiId() const{ return m_apiId; } /** *

The API ID.

*/ inline void SetApiId(const Aws::String& value) { m_apiId = value; } /** *

The API ID.

*/ inline void SetApiId(Aws::String&& value) { m_apiId = std::move(value); } /** *

The API ID.

*/ inline void SetApiId(const char* value) { m_apiId.assign(value); } /** *

The API ID.

*/ inline ImportApiResult& WithApiId(const Aws::String& value) { SetApiId(value); return *this;} /** *

The API ID.

*/ inline ImportApiResult& WithApiId(Aws::String&& value) { SetApiId(std::move(value)); return *this;} /** *

The API ID.

*/ inline ImportApiResult& WithApiId(const char* value) { SetApiId(value); return *this;} /** *

An API key selection expression. Supported only for WebSocket APIs. See API * Key Selection Expressions.

*/ inline const Aws::String& GetApiKeySelectionExpression() const{ return m_apiKeySelectionExpression; } /** *

An API key selection expression. Supported only for WebSocket APIs. See API * Key Selection Expressions.

*/ inline void SetApiKeySelectionExpression(const Aws::String& value) { m_apiKeySelectionExpression = value; } /** *

An API key selection expression. Supported only for WebSocket APIs. See API * Key Selection Expressions.

*/ inline void SetApiKeySelectionExpression(Aws::String&& value) { m_apiKeySelectionExpression = std::move(value); } /** *

An API key selection expression. Supported only for WebSocket APIs. See API * Key Selection Expressions.

*/ inline void SetApiKeySelectionExpression(const char* value) { m_apiKeySelectionExpression.assign(value); } /** *

An API key selection expression. Supported only for WebSocket APIs. See API * Key Selection Expressions.

*/ inline ImportApiResult& WithApiKeySelectionExpression(const Aws::String& value) { SetApiKeySelectionExpression(value); return *this;} /** *

An API key selection expression. Supported only for WebSocket APIs. See API * Key Selection Expressions.

*/ inline ImportApiResult& WithApiKeySelectionExpression(Aws::String&& value) { SetApiKeySelectionExpression(std::move(value)); return *this;} /** *

An API key selection expression. Supported only for WebSocket APIs. See API * Key Selection Expressions.

*/ inline ImportApiResult& WithApiKeySelectionExpression(const char* value) { SetApiKeySelectionExpression(value); return *this;} /** *

A CORS configuration. Supported only for HTTP APIs.

*/ inline const Cors& GetCorsConfiguration() const{ return m_corsConfiguration; } /** *

A CORS configuration. Supported only for HTTP APIs.

*/ inline void SetCorsConfiguration(const Cors& value) { m_corsConfiguration = value; } /** *

A CORS configuration. Supported only for HTTP APIs.

*/ inline void SetCorsConfiguration(Cors&& value) { m_corsConfiguration = std::move(value); } /** *

A CORS configuration. Supported only for HTTP APIs.

*/ inline ImportApiResult& WithCorsConfiguration(const Cors& value) { SetCorsConfiguration(value); return *this;} /** *

A CORS configuration. Supported only for HTTP APIs.

*/ inline ImportApiResult& WithCorsConfiguration(Cors&& value) { SetCorsConfiguration(std::move(value)); return *this;} /** *

The timestamp when the API was created.

*/ inline const Aws::Utils::DateTime& GetCreatedDate() const{ return m_createdDate; } /** *

The timestamp when the API was created.

*/ inline void SetCreatedDate(const Aws::Utils::DateTime& value) { m_createdDate = value; } /** *

The timestamp when the API was created.

*/ inline void SetCreatedDate(Aws::Utils::DateTime&& value) { m_createdDate = std::move(value); } /** *

The timestamp when the API was created.

*/ inline ImportApiResult& WithCreatedDate(const Aws::Utils::DateTime& value) { SetCreatedDate(value); return *this;} /** *

The timestamp when the API was created.

*/ inline ImportApiResult& WithCreatedDate(Aws::Utils::DateTime&& value) { SetCreatedDate(std::move(value)); return *this;} /** *

The description of the API.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

The description of the API.

*/ inline void SetDescription(const Aws::String& value) { m_description = value; } /** *

The description of the API.

*/ inline void SetDescription(Aws::String&& value) { m_description = std::move(value); } /** *

The description of the API.

*/ inline void SetDescription(const char* value) { m_description.assign(value); } /** *

The description of the API.

*/ inline ImportApiResult& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

The description of the API.

*/ inline ImportApiResult& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

The description of the API.

*/ inline ImportApiResult& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

Avoid validating models when creating a deployment. Supported only for * WebSocket APIs.

*/ inline bool GetDisableSchemaValidation() const{ return m_disableSchemaValidation; } /** *

Avoid validating models when creating a deployment. Supported only for * WebSocket APIs.

*/ inline void SetDisableSchemaValidation(bool value) { m_disableSchemaValidation = value; } /** *

Avoid validating models when creating a deployment. Supported only for * WebSocket APIs.

*/ inline ImportApiResult& WithDisableSchemaValidation(bool value) { SetDisableSchemaValidation(value); return *this;} /** *

Specifies whether clients can invoke your API by using the default * execute-api endpoint. By default, clients can invoke your API with the default * https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that * clients use a custom domain name to invoke your API, disable the default * endpoint.

*/ inline bool GetDisableExecuteApiEndpoint() const{ return m_disableExecuteApiEndpoint; } /** *

Specifies whether clients can invoke your API by using the default * execute-api endpoint. By default, clients can invoke your API with the default * https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that * clients use a custom domain name to invoke your API, disable the default * endpoint.

*/ inline void SetDisableExecuteApiEndpoint(bool value) { m_disableExecuteApiEndpoint = value; } /** *

Specifies whether clients can invoke your API by using the default * execute-api endpoint. By default, clients can invoke your API with the default * https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that * clients use a custom domain name to invoke your API, disable the default * endpoint.

*/ inline ImportApiResult& WithDisableExecuteApiEndpoint(bool value) { SetDisableExecuteApiEndpoint(value); return *this;} /** *

The validation information during API import. This may include particular * properties of your OpenAPI definition which are ignored during import. Supported * only for HTTP APIs.

*/ inline const Aws::Vector& GetImportInfo() const{ return m_importInfo; } /** *

The validation information during API import. This may include particular * properties of your OpenAPI definition which are ignored during import. Supported * only for HTTP APIs.

*/ inline void SetImportInfo(const Aws::Vector& value) { m_importInfo = value; } /** *

The validation information during API import. This may include particular * properties of your OpenAPI definition which are ignored during import. Supported * only for HTTP APIs.

*/ inline void SetImportInfo(Aws::Vector&& value) { m_importInfo = std::move(value); } /** *

The validation information during API import. This may include particular * properties of your OpenAPI definition which are ignored during import. Supported * only for HTTP APIs.

*/ inline ImportApiResult& WithImportInfo(const Aws::Vector& value) { SetImportInfo(value); return *this;} /** *

The validation information during API import. This may include particular * properties of your OpenAPI definition which are ignored during import. Supported * only for HTTP APIs.

*/ inline ImportApiResult& WithImportInfo(Aws::Vector&& value) { SetImportInfo(std::move(value)); return *this;} /** *

The validation information during API import. This may include particular * properties of your OpenAPI definition which are ignored during import. Supported * only for HTTP APIs.

*/ inline ImportApiResult& AddImportInfo(const Aws::String& value) { m_importInfo.push_back(value); return *this; } /** *

The validation information during API import. This may include particular * properties of your OpenAPI definition which are ignored during import. Supported * only for HTTP APIs.

*/ inline ImportApiResult& AddImportInfo(Aws::String&& value) { m_importInfo.push_back(std::move(value)); return *this; } /** *

The validation information during API import. This may include particular * properties of your OpenAPI definition which are ignored during import. Supported * only for HTTP APIs.

*/ inline ImportApiResult& AddImportInfo(const char* value) { m_importInfo.push_back(value); return *this; } /** *

The name of the API.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the API.

*/ inline void SetName(const Aws::String& value) { m_name = value; } /** *

The name of the API.

*/ inline void SetName(Aws::String&& value) { m_name = std::move(value); } /** *

The name of the API.

*/ inline void SetName(const char* value) { m_name.assign(value); } /** *

The name of the API.

*/ inline ImportApiResult& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the API.

*/ inline ImportApiResult& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the API.

*/ inline ImportApiResult& WithName(const char* value) { SetName(value); return *this;} /** *

The API protocol.

*/ inline const ProtocolType& GetProtocolType() const{ return m_protocolType; } /** *

The API protocol.

*/ inline void SetProtocolType(const ProtocolType& value) { m_protocolType = value; } /** *

The API protocol.

*/ inline void SetProtocolType(ProtocolType&& value) { m_protocolType = std::move(value); } /** *

The API protocol.

*/ inline ImportApiResult& WithProtocolType(const ProtocolType& value) { SetProtocolType(value); return *this;} /** *

The API protocol.

*/ inline ImportApiResult& WithProtocolType(ProtocolType&& value) { SetProtocolType(std::move(value)); return *this;} /** *

The route selection expression for the API. For HTTP APIs, the * routeSelectionExpression must be ${request.method} ${request.path}. If not * provided, this will be the default for HTTP APIs. This property is required for * WebSocket APIs.

*/ inline const Aws::String& GetRouteSelectionExpression() const{ return m_routeSelectionExpression; } /** *

The route selection expression for the API. For HTTP APIs, the * routeSelectionExpression must be ${request.method} ${request.path}. If not * provided, this will be the default for HTTP APIs. This property is required for * WebSocket APIs.

*/ inline void SetRouteSelectionExpression(const Aws::String& value) { m_routeSelectionExpression = value; } /** *

The route selection expression for the API. For HTTP APIs, the * routeSelectionExpression must be ${request.method} ${request.path}. If not * provided, this will be the default for HTTP APIs. This property is required for * WebSocket APIs.

*/ inline void SetRouteSelectionExpression(Aws::String&& value) { m_routeSelectionExpression = std::move(value); } /** *

The route selection expression for the API. For HTTP APIs, the * routeSelectionExpression must be ${request.method} ${request.path}. If not * provided, this will be the default for HTTP APIs. This property is required for * WebSocket APIs.

*/ inline void SetRouteSelectionExpression(const char* value) { m_routeSelectionExpression.assign(value); } /** *

The route selection expression for the API. For HTTP APIs, the * routeSelectionExpression must be ${request.method} ${request.path}. If not * provided, this will be the default for HTTP APIs. This property is required for * WebSocket APIs.

*/ inline ImportApiResult& WithRouteSelectionExpression(const Aws::String& value) { SetRouteSelectionExpression(value); return *this;} /** *

The route selection expression for the API. For HTTP APIs, the * routeSelectionExpression must be ${request.method} ${request.path}. If not * provided, this will be the default for HTTP APIs. This property is required for * WebSocket APIs.

*/ inline ImportApiResult& WithRouteSelectionExpression(Aws::String&& value) { SetRouteSelectionExpression(std::move(value)); return *this;} /** *

The route selection expression for the API. For HTTP APIs, the * routeSelectionExpression must be ${request.method} ${request.path}. If not * provided, this will be the default for HTTP APIs. This property is required for * WebSocket APIs.

*/ inline ImportApiResult& WithRouteSelectionExpression(const char* value) { SetRouteSelectionExpression(value); return *this;} /** *

A collection of tags associated with the API.

*/ inline const Aws::Map& GetTags() const{ return m_tags; } /** *

A collection of tags associated with the API.

*/ inline void SetTags(const Aws::Map& value) { m_tags = value; } /** *

A collection of tags associated with the API.

*/ inline void SetTags(Aws::Map&& value) { m_tags = std::move(value); } /** *

A collection of tags associated with the API.

*/ inline ImportApiResult& WithTags(const Aws::Map& value) { SetTags(value); return *this;} /** *

A collection of tags associated with the API.

*/ inline ImportApiResult& WithTags(Aws::Map&& value) { SetTags(std::move(value)); return *this;} /** *

A collection of tags associated with the API.

*/ inline ImportApiResult& AddTags(const Aws::String& key, const Aws::String& value) { m_tags.emplace(key, value); return *this; } /** *

A collection of tags associated with the API.

*/ inline ImportApiResult& AddTags(Aws::String&& key, const Aws::String& value) { m_tags.emplace(std::move(key), value); return *this; } /** *

A collection of tags associated with the API.

*/ inline ImportApiResult& AddTags(const Aws::String& key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } /** *

A collection of tags associated with the API.

*/ inline ImportApiResult& AddTags(Aws::String&& key, Aws::String&& value) { m_tags.emplace(std::move(key), std::move(value)); return *this; } /** *

A collection of tags associated with the API.

*/ inline ImportApiResult& AddTags(const char* key, Aws::String&& value) { m_tags.emplace(key, std::move(value)); return *this; } /** *

A collection of tags associated with the API.

*/ inline ImportApiResult& AddTags(Aws::String&& key, const char* value) { m_tags.emplace(std::move(key), value); return *this; } /** *

A collection of tags associated with the API.

*/ inline ImportApiResult& AddTags(const char* key, const char* value) { m_tags.emplace(key, value); return *this; } /** *

A version identifier for the API.

*/ inline const Aws::String& GetVersion() const{ return m_version; } /** *

A version identifier for the API.

*/ inline void SetVersion(const Aws::String& value) { m_version = value; } /** *

A version identifier for the API.

*/ inline void SetVersion(Aws::String&& value) { m_version = std::move(value); } /** *

A version identifier for the API.

*/ inline void SetVersion(const char* value) { m_version.assign(value); } /** *

A version identifier for the API.

*/ inline ImportApiResult& WithVersion(const Aws::String& value) { SetVersion(value); return *this;} /** *

A version identifier for the API.

*/ inline ImportApiResult& WithVersion(Aws::String&& value) { SetVersion(std::move(value)); return *this;} /** *

A version identifier for the API.

*/ inline ImportApiResult& WithVersion(const char* value) { SetVersion(value); return *this;} /** *

The warning messages reported when failonwarnings is turned on during API * import.

*/ inline const Aws::Vector& GetWarnings() const{ return m_warnings; } /** *

The warning messages reported when failonwarnings is turned on during API * import.

*/ inline void SetWarnings(const Aws::Vector& value) { m_warnings = value; } /** *

The warning messages reported when failonwarnings is turned on during API * import.

*/ inline void SetWarnings(Aws::Vector&& value) { m_warnings = std::move(value); } /** *

The warning messages reported when failonwarnings is turned on during API * import.

*/ inline ImportApiResult& WithWarnings(const Aws::Vector& value) { SetWarnings(value); return *this;} /** *

The warning messages reported when failonwarnings is turned on during API * import.

*/ inline ImportApiResult& WithWarnings(Aws::Vector&& value) { SetWarnings(std::move(value)); return *this;} /** *

The warning messages reported when failonwarnings is turned on during API * import.

*/ inline ImportApiResult& AddWarnings(const Aws::String& value) { m_warnings.push_back(value); return *this; } /** *

The warning messages reported when failonwarnings is turned on during API * import.

*/ inline ImportApiResult& AddWarnings(Aws::String&& value) { m_warnings.push_back(std::move(value)); return *this; } /** *

The warning messages reported when failonwarnings is turned on during API * import.

*/ inline ImportApiResult& AddWarnings(const char* value) { m_warnings.push_back(value); return *this; } inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline ImportApiResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline ImportApiResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline ImportApiResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_apiEndpoint; bool m_apiGatewayManaged; Aws::String m_apiId; Aws::String m_apiKeySelectionExpression; Cors m_corsConfiguration; Aws::Utils::DateTime m_createdDate; Aws::String m_description; bool m_disableSchemaValidation; bool m_disableExecuteApiEndpoint; Aws::Vector m_importInfo; Aws::String m_name; ProtocolType m_protocolType; Aws::String m_routeSelectionExpression; Aws::Map m_tags; Aws::String m_version; Aws::Vector m_warnings; Aws::String m_requestId; }; } // namespace Model } // namespace ApiGatewayV2 } // namespace Aws