public static interface PutRestApiRequest.Builder extends APIGatewayRequest.Builder, CopyableBuilder<PutRestApiRequest.Builder,PutRestApiRequest>
Modifier and Type | Method and Description |
---|---|
PutRestApiRequest.Builder |
body(ByteBuffer body)
The PUT request body containing external API definitions.
|
PutRestApiRequest.Builder |
failOnWarnings(Boolean failOnWarnings)
A query parameter to indicate whether to rollback the API update (
true ) or not (
false ) when a warning is encountered. |
PutRestApiRequest.Builder |
mode(PutMode mode)
The
mode query parameter to specify the update mode. |
PutRestApiRequest.Builder |
mode(String mode)
The
mode query parameter to specify the update mode. |
PutRestApiRequest.Builder |
parameters(Map<String,String> parameters)
Custom header parameters as part of the request.
|
PutRestApiRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
PutRestApiRequest.Builder |
restApiId(String restApiId)
The string identifier of the associated RestApi.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
PutRestApiRequest.Builder restApiId(String restApiId)
The string identifier of the associated RestApi.
restApiId
- The string identifier of the associated RestApi.PutRestApiRequest.Builder mode(String mode)
The mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite".
By default, the update mode is "merge".
PutRestApiRequest.Builder mode(PutMode mode)
The mode
query parameter to specify the update mode. Valid values are "merge" and "overwrite".
By default, the update mode is "merge".
PutRestApiRequest.Builder failOnWarnings(Boolean failOnWarnings)
A query parameter to indicate whether to rollback the API update (true
) or not (
false
) when a warning is encountered. The default value is false
.
failOnWarnings
- A query parameter to indicate whether to rollback the API update (true
) or not (
false
) when a warning is encountered. The default value is false
.PutRestApiRequest.Builder parameters(Map<String,String> parameters)
Custom header parameters as part of the request. For example, to exclude DocumentationParts from an
imported API, set ignore=documentation
as a parameters
value, as in the AWS CLI
command of
aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json
.
parameters
- Custom header parameters as part of the request. For example, to exclude DocumentationParts
from an imported API, set ignore=documentation
as a parameters
value, as in
the AWS CLI command of
aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json
.PutRestApiRequest.Builder body(ByteBuffer body)
The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.
To preserve immutability, the remaining bytes in the provided buffer will be copied into a new buffer when set.
body
- The PUT request body containing external API definitions. Currently, only Swagger definition JSON
files are supported. The maximum size of the API definition file is 2MB.PutRestApiRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.