public static interface UpdateRestApiResponse.Builder extends ApiGatewayResponse.Builder, SdkPojo, CopyableBuilder<UpdateRestApiResponse.Builder,UpdateRestApiResponse>
Modifier and Type | Method and Description |
---|---|
UpdateRestApiResponse.Builder |
apiKeySource(ApiKeySourceType apiKeySource)
The source of the API key for metering requests according to a usage plan.
|
UpdateRestApiResponse.Builder |
apiKeySource(String apiKeySource)
The source of the API key for metering requests according to a usage plan.
|
UpdateRestApiResponse.Builder |
binaryMediaTypes(Collection<String> binaryMediaTypes)
The list of binary media types supported by the RestApi.
|
UpdateRestApiResponse.Builder |
binaryMediaTypes(String... binaryMediaTypes)
The list of binary media types supported by the RestApi.
|
UpdateRestApiResponse.Builder |
createdDate(Instant createdDate)
The timestamp when the API was created.
|
UpdateRestApiResponse.Builder |
description(String description)
The API's description.
|
default UpdateRestApiResponse.Builder |
endpointConfiguration(Consumer<EndpointConfiguration.Builder> endpointConfiguration)
The endpoint configuration of this RestApi showing the endpoint types of the API.
|
UpdateRestApiResponse.Builder |
endpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this RestApi showing the endpoint types of the API.
|
UpdateRestApiResponse.Builder |
id(String id)
The API's identifier.
|
UpdateRestApiResponse.Builder |
minimumCompressionSize(Integer minimumCompressionSize)
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes,
inclusive) or disable compression (with a null value) on an API.
|
UpdateRestApiResponse.Builder |
name(String name)
The API's name.
|
UpdateRestApiResponse.Builder |
policy(String policy)
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method
configuration.
|
UpdateRestApiResponse.Builder |
version(String version)
A version identifier for the API.
|
UpdateRestApiResponse.Builder |
warnings(Collection<String> warnings)
The warning messages reported when
failonwarnings is turned on during API import. |
UpdateRestApiResponse.Builder |
warnings(String... warnings)
The warning messages reported when
failonwarnings is turned on during API import. |
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
copy
applyMutation, build
UpdateRestApiResponse.Builder id(String id)
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
id
- The API's identifier. This identifier is unique across all of your APIs in API Gateway.UpdateRestApiResponse.Builder name(String name)
The API's name.
name
- The API's name.UpdateRestApiResponse.Builder description(String description)
The API's description.
description
- The API's description.UpdateRestApiResponse.Builder createdDate(Instant createdDate)
The timestamp when the API was created.
createdDate
- The timestamp when the API was created.UpdateRestApiResponse.Builder version(String version)
A version identifier for the API.
version
- A version identifier for the API.UpdateRestApiResponse.Builder warnings(Collection<String> warnings)
The warning messages reported when failonwarnings
is turned on during API import.
warnings
- The warning messages reported when failonwarnings
is turned on during API import.UpdateRestApiResponse.Builder warnings(String... warnings)
The warning messages reported when failonwarnings
is turned on during API import.
warnings
- The warning messages reported when failonwarnings
is turned on during API import.UpdateRestApiResponse.Builder binaryMediaTypes(Collection<String> binaryMediaTypes)
UpdateRestApiResponse.Builder binaryMediaTypes(String... binaryMediaTypes)
UpdateRestApiResponse.Builder minimumCompressionSize(Integer minimumCompressionSize)
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
minimumCompressionSize
- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M)
bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled,
compression or decompression is not applied on the payload if the payload size is smaller than this
value. Setting it to zero allows compression for any payload size.UpdateRestApiResponse.Builder apiKeySource(String apiKeySource)
The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from the X-API-Key
header of a request.AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom
authorizer.apiKeySource
- The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from the X-API-Key
header of a request.AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom
authorizer.ApiKeySourceType
,
ApiKeySourceType
UpdateRestApiResponse.Builder apiKeySource(ApiKeySourceType apiKeySource)
The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from the X-API-Key
header of a request.AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom
authorizer.apiKeySource
- The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from the X-API-Key
header of a request.AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom
authorizer.ApiKeySourceType
,
ApiKeySourceType
UpdateRestApiResponse.Builder endpointConfiguration(EndpointConfiguration endpointConfiguration)
The endpoint configuration of this RestApi showing the endpoint types of the API.
endpointConfiguration
- The endpoint configuration of this RestApi showing the endpoint types of the API.default UpdateRestApiResponse.Builder endpointConfiguration(Consumer<EndpointConfiguration.Builder> endpointConfiguration)
The endpoint configuration of this RestApi showing the endpoint types of the API.
This is a convenience that creates an instance of theEndpointConfiguration.Builder
avoiding the need
to create one manually via EndpointConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to endpointConfiguration(EndpointConfiguration)
.endpointConfiguration
- a consumer that will call methods on EndpointConfiguration.Builder
endpointConfiguration(EndpointConfiguration)
UpdateRestApiResponse.Builder policy(String policy)
policy
- A stringified JSON policy document that applies to this RestApi regardless of the caller and
Method configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.