public static interface UpdateIntegrationResponseResponse.Builder extends ApiGatewayResponse.Builder, CopyableBuilder<UpdateIntegrationResponseResponse.Builder,UpdateIntegrationResponseResponse>
Modifier and Type | Method and Description |
---|---|
UpdateIntegrationResponseResponse.Builder |
contentHandling(ContentHandlingStrategy contentHandling)
Specifies how to handle response payload content type conversions.
|
UpdateIntegrationResponseResponse.Builder |
contentHandling(String contentHandling)
Specifies how to handle response payload content type conversions.
|
UpdateIntegrationResponseResponse.Builder |
responseParameters(Map<String,String> responseParameters)
A key-value map specifying response parameters that are passed to the method response from the back end.
|
UpdateIntegrationResponseResponse.Builder |
responseTemplates(Map<String,String> responseTemplates)
Specifies the templates used to transform the integration response body.
|
UpdateIntegrationResponseResponse.Builder |
selectionPattern(String selectionPattern)
Specifies the regular expression (regex) pattern used to choose an integration response based on the response
from the back end.
|
UpdateIntegrationResponseResponse.Builder |
statusCode(String statusCode)
Specifies the status code that is used to map the integration response to an existing MethodResponse.
|
build
sdkHttpResponse, sdkHttpResponse
copy
applyMutation, build
UpdateIntegrationResponseResponse.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.UpdateIntegrationResponseResponse.Builder selectionPattern(String selectionPattern)
Specifies the regular expression (regex) pattern used to choose an integration response based on the response
from the back end. For example, if the success response returns nothing and the error response returns some
string, you could use the .+
regex to match error response. However, make sure that the error
response does not contain any newline (\n
) character in such cases. If the back end is an AWS
Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the
HTTP status code is matched.
selectionPattern
- Specifies the regular expression (regex) pattern used to choose an integration response based on the
response from the back end. For example, if the success response returns nothing and the error
response returns some string, you could use the .+
regex to match error response.
However, make sure that the error response does not contain any newline (\n
) character in
such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is
matched. For all other HTTP and AWS back ends, the HTTP status code is matched.UpdateIntegrationResponseResponse.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
is a valid and unique response header name and JSON-expression
is 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
is a valid and
unique response header name and JSON-expression
is a valid JSON expression without the
$
prefix.UpdateIntegrationResponseResponse.Builder responseTemplates(Map<String,String> responseTemplates)
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
responseTemplates
- Specifies the templates used to transform the integration response body. Response templates are
represented as a key/value map, with a content-type as the key and a template as the value.UpdateIntegrationResponseResponse.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
UpdateIntegrationResponseResponse.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
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.