software.amazon.awssdk.services.apigateway.model

Interface ImportRestApiRequest.Builder

All Superinterfaces:

ApiGatewayRequest.Builder, AwsRequest.Builder, CopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>, SdkBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>, SdkRequest.Builder

Enclosing class:

ImportRestApiRequest

public static interface ImportRestApiRequest.Builder
extends ApiGatewayRequest.Builder, CopyableBuilder<ImportRestApiRequest.Builder,ImportRestApiRequest>

Method Summary

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.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

failOnWarnings

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

parameters

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:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

body

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ImportRestApiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ImportRestApiRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.