Package software.amazon.awssdk.services.apigateway.model

Interface GetExportRequest.Builder

All Superinterfaces:

CopyableBuilder<GetExportRequest.Builder,GetExportRequest>, SdkBuilder<GetExportRequest.Builder,GetExportRequest>

Enclosing class:

GetExportRequest

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

Method Summary

Modifier and Type	Method	Description
GetExportRequest.Builder	accepts(String accepts)	The content-type of the export, for example application/json.
GetExportRequest.Builder	exportType(String exportType)	The type of export.
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)	The identifier of the RestApi to be exported.
GetExportRequest.Builder	stageName(String stageName)	The name of the Stage that will be exported.

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

copy

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

apply, build

Method Detail

restApiId

GetExportRequest.Builder restApiId(String restApiId)

The identifier of the RestApi to be exported.

Parameters:

restApiId - The identifier of the RestApi to be exported.

Returns:

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

stageName

GetExportRequest.Builder stageName(String stageName)

The name of the Stage that will be exported.

Parameters:

stageName - 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)

The type of export. Currently only 'swagger' is supported.

Parameters:

exportType - The type of export. Currently only 'swagger' is supported.

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 swagger, any combination of the following parameters are supported: integrations will export the API with x-amazon-apigateway-integration 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 swagger, any combination of the following parameters are supported: integrations will export the API with x-amazon-apigateway-integration 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 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 of 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.