software.amazon.awssdk.services.apigateway.model

Interface ImportRestApiRequest.Builder

All Superinterfaces:

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

Enclosing class:

ImportRestApiRequest

public static interface ImportRestApiRequest.Builder
extends ApiGatewayRequest.Builder, SdkPojo, 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)
ImportRestApiRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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.core.SdkPojo

equalsBySdkFields, sdkFields

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, 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.

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, 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.

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 OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

Parameters:

body - The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

Returns:

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

overrideConfiguration

ImportRestApiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder