software.amazon.awssdk.services.apigateway.model

Interface GetExportRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetExportRequest

public static interface GetExportRequest.Builder
extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<GetExportRequest.Builder,GetExportRequest>

Method Summary

Modifier and Type	Method and Description
GetExportRequest.Builder	accepts(String accepts) The content-type of the export, for example application/json.
GetExportRequest.Builder	exportType(String exportType) [Required] The type of export.
GetExportRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetExportRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetExportRequest.Builder	parameters(Map<String,String> parameters) A key-value map of query string parameters that specify properties of the export, depending on the requested exportType.
GetExportRequest.Builder	restApiId(String restApiId) [Required] The string identifier of the associated RestApi.
GetExportRequest.Builder	stageName(String stageName) [Required] The name of the Stage that will be exported.

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

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

restApiId

GetExportRequest.Builder restApiId(String restApiId)

[Required] The string identifier of the associated RestApi.

Parameters:

restApiId - [Required] The string identifier of the associated RestApi.

Returns:

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

stageName

GetExportRequest.Builder stageName(String stageName)

[Required] The name of the Stage that will be exported.

Parameters:

stageName - [Required] The name of the Stage that will be exported.

Returns:

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

exportType

GetExportRequest.Builder exportType(String exportType)

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Parameters:

exportType - [Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

Returns:

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

parameters

GetExportRequest.Builder parameters(Map<String,String> parameters)

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Parameters:

parameters - A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

Returns:

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

accepts

GetExportRequest.Builder accepts(String accepts)

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType of oas30 and swagger. This should be specified in the Accept header for direct API requests.

Parameters:

accepts - The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

Returns:

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

overrideConfiguration

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

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