public static interface ExportApiRequest.Builder extends ApiGatewayV2Request.Builder, SdkPojo, CopyableBuilder<ExportApiRequest.Builder,ExportApiRequest>
Modifier and Type | Method and Description |
---|---|
ExportApiRequest.Builder |
apiId(String apiId)
The API identifier.
|
ExportApiRequest.Builder |
exportVersion(String exportVersion)
The version of the API Gateway export algorithm.
|
ExportApiRequest.Builder |
includeExtensions(Boolean includeExtensions)
Specifies whether to include API
Gateway extensions in the exported API definition.
|
ExportApiRequest.Builder |
outputType(String outputType)
The output type of the exported definition file.
|
ExportApiRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ExportApiRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
ExportApiRequest.Builder |
specification(String specification)
The version of the API specification to use.
|
ExportApiRequest.Builder |
stageName(String stageName)
The name of the API stage to export.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
ExportApiRequest.Builder apiId(String apiId)
The API identifier.
apiId
- The API identifier.ExportApiRequest.Builder exportVersion(String exportVersion)
The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
exportVersion
- The version of the API Gateway export algorithm. API Gateway uses the latest version by default.
Currently, the only supported version is 1.0.ExportApiRequest.Builder includeExtensions(Boolean includeExtensions)
Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
includeExtensions
- Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by
default.ExportApiRequest.Builder outputType(String outputType)
The output type of the exported definition file. Valid values are JSON and YAML.
outputType
- The output type of the exported definition file. Valid values are JSON and YAML.ExportApiRequest.Builder specification(String specification)
The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
specification
- The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.ExportApiRequest.Builder stageName(String stageName)
The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
stageName
- The name of the API stage to export. If you don't specify this property, a representation of the
latest API configuration is exported.ExportApiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.ExportApiRequest.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.