Interface PutIntegrationResponseResponse.Builder
- All Superinterfaces:
ApiGatewayResponse.Builder
,AwsResponse.Builder
,Buildable
,CopyableBuilder<PutIntegrationResponseResponse.Builder,
,PutIntegrationResponseResponse> SdkBuilder<PutIntegrationResponseResponse.Builder,
,PutIntegrationResponseResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
PutIntegrationResponseResponse
-
Method Summary
Modifier and TypeMethodDescriptioncontentHandling
(String contentHandling) Specifies how to handle response payload content type conversions.contentHandling
(ContentHandlingStrategy contentHandling) Specifies how to handle response payload content type conversions.responseParameters
(Map<String, String> responseParameters) A key-value map specifying response parameters that are passed to the method response from the back end.responseTemplates
(Map<String, String> responseTemplates) Specifies the templates used to transform the integration response body.selectionPattern
(String selectionPattern) Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.statusCode
(String statusCodeValue) Specifies the status code that is used to map the integration response to an existing MethodResponse.Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
statusCode
Specifies the status code that is used to map the integration response to an existing MethodResponse.
- Parameters:
statusCodeValue
- Specifies the status code that is used to map the integration response to an existing MethodResponse.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.- Parameters:
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 Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
is a valid and unique response header name andJSON-expression
is a valid JSON expression without the$
prefix.- Parameters:
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 ofmethod.response.header.{name}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
is a valid and unique response header name andJSON-expression
is a valid JSON expression without the$
prefix.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentHandling
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Parameters:
contentHandling
- Specifies how to handle response payload content type conversions. Supported values areCONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
contentHandling
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Parameters:
contentHandling
- Specifies how to handle response payload content type conversions. Supported values areCONVERT_TO_BINARY
andCONVERT_TO_TEXT
, with the following behaviors:If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-