public static interface ImportRestApiRequest.Builder extends ApiGatewayRequest.Builder, CopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>
Modifier and Type | Method and Description |
---|---|
ImportRestApiRequest.Builder |
body(SdkBytes body)
The POST request body containing external API definitions.
|
ImportRestApiRequest.Builder |
failOnWarnings(Boolean failOnWarnings)
A query parameter to indicate whether to rollback the API creation (
true ) or not (
false ) when a warning is encountered. |
ImportRestApiRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ImportRestApiRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
ImportRestApiRequest.Builder |
parameters(Map<String,String> parameters)
A key-value map of context-specific query string parameters specifying the behavior of different API
importing operations.
|
build
overrideConfiguration
copy
applyMutation, build
ImportRestApiRequest.Builder failOnWarnings(Boolean 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
.
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
.ImportRestApiRequest.Builder parameters(Map<String,String> 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
orendpointConfigurationTypes=REGIONAL
. 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:
aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json
The AWS CLI command to set the regional endpoint on the imported API is:
aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json
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
orendpointConfigurationTypes=REGIONAL
. 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:
aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json
The AWS CLI command to set the regional endpoint on the imported API is:
aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json
ImportRestApiRequest.Builder body(SdkBytes body)
The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.
body
- The POST request body containing external API definitions. Currently, only Swagger definition JSON
files are supported. The maximum size of the API definition file is 2MB.ImportRestApiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.ImportRestApiRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.