public static interface PutIntegrationResponseRequest.Builder extends ApiGatewayRequest.Builder, CopyableBuilder<PutIntegrationResponseRequest.Builder,PutIntegrationResponseRequest>
Modifier and Type | Method and Description |
---|---|
PutIntegrationResponseRequest.Builder |
contentHandling(ContentHandlingStrategy contentHandling)
Specifies how to handle response payload content type conversions.
|
PutIntegrationResponseRequest.Builder |
contentHandling(String contentHandling)
Specifies how to handle response payload content type conversions.
|
PutIntegrationResponseRequest.Builder |
httpMethod(String httpMethod)
Specifies a put integration response request's HTTP method.
|
PutIntegrationResponseRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
PutIntegrationResponseRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
PutIntegrationResponseRequest.Builder |
resourceId(String resourceId)
Specifies a put integration response request's resource identifier.
|
PutIntegrationResponseRequest.Builder |
responseParameters(Map<String,String> responseParameters)
A key-value map specifying response parameters that are passed to the method response from the back end.
|
PutIntegrationResponseRequest.Builder |
responseTemplates(Map<String,String> responseTemplates)
Specifies a put integration response's templates.
|
PutIntegrationResponseRequest.Builder |
restApiId(String restApiId)
The string identifier of the associated RestApi.
|
PutIntegrationResponseRequest.Builder |
selectionPattern(String selectionPattern)
Specifies the selection pattern of a put integration response.
|
PutIntegrationResponseRequest.Builder |
statusCode(String statusCode)
Specifies the status code that is used to map the integration response to an existing MethodResponse.
|
build
overrideConfiguration
copy
applyMutation, build
PutIntegrationResponseRequest.Builder restApiId(String restApiId)
The string identifier of the associated RestApi.
restApiId
- The string identifier of the associated RestApi.PutIntegrationResponseRequest.Builder resourceId(String resourceId)
Specifies a put integration response request's resource identifier.
resourceId
- Specifies a put integration response request's resource identifier.PutIntegrationResponseRequest.Builder httpMethod(String httpMethod)
Specifies a put integration response request's HTTP method.
httpMethod
- Specifies a put integration response request's HTTP method.PutIntegrationResponseRequest.Builder statusCode(String statusCode)
Specifies the status code that is used to map the integration response to an existing MethodResponse.
statusCode
- Specifies the status code that is used to map the integration response to an existing
MethodResponse.PutIntegrationResponseRequest.Builder selectionPattern(String selectionPattern)
Specifies the selection pattern of a put integration response.
selectionPattern
- Specifies the selection pattern of a put integration response.PutIntegrationResponseRequest.Builder responseParameters(Map<String,String> responseParameters)
A key-value map specifying response parameters that are passed to the method response from the back end. The
key is a method response header parameter name and the mapped value is an integration response header value,
a static value enclosed within a pair of single quotes, or a JSON expression from the integration response
body. The mapping key must match the pattern of method.response.header.{name}
, where
name
is a valid and unique header name. The mapped non-static value must match the pattern of
integration.response.header.{name}
or integration.response.body.{JSON-expression}
,
where name
must be a valid and unique response header name and JSON-expression
a
valid JSON expression without the $
prefix.
responseParameters
- A key-value map specifying response parameters that are passed to the method response from the back
end. The key is a method response header parameter name and the mapped value is an integration
response header value, a static value enclosed within a pair of single quotes, or a JSON expression
from the integration response body. The mapping key must match the pattern of
method.response.header.{name}
, where name
is a valid and unique header name.
The mapped non-static value must match the pattern of integration.response.header.{name}
or integration.response.body.{JSON-expression}
, where name
must be a valid
and unique response header name and JSON-expression
a valid JSON expression without the
$
prefix.PutIntegrationResponseRequest.Builder responseTemplates(Map<String,String> responseTemplates)
Specifies a put integration response's templates.
responseTemplates
- Specifies a put integration response's templates.PutIntegrationResponseRequest.Builder contentHandling(String contentHandling)
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a response payload from a Base64-encoded string to the corresponding
binary blob.
CONVERT_TO_TEXT
: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
contentHandling
- Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a response payload from a Base64-encoded string to the
corresponding binary blob.
CONVERT_TO_TEXT
: Converts a response payload from a binary blob to a Base64-encoded
string.
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
ContentHandlingStrategy
,
ContentHandlingStrategy
PutIntegrationResponseRequest.Builder contentHandling(ContentHandlingStrategy contentHandling)
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a response payload from a Base64-encoded string to the corresponding
binary blob.
CONVERT_TO_TEXT
: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
contentHandling
- Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a response payload from a Base64-encoded string to the
corresponding binary blob.
CONVERT_TO_TEXT
: Converts a response payload from a binary blob to a Base64-encoded
string.
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
ContentHandlingStrategy
,
ContentHandlingStrategy
PutIntegrationResponseRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.PutIntegrationResponseRequest.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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.