software.amazon.awssdk.services.apigatewayv2.model

Interface IntegrationResponse.Builder

All Superinterfaces:

Buildable, CopyableBuilder<IntegrationResponse.Builder,IntegrationResponse>, SdkBuilder<IntegrationResponse.Builder,IntegrationResponse>, SdkPojo

Enclosing class:

IntegrationResponse

public static interface IntegrationResponse.Builder
extends SdkPojo, CopyableBuilder<IntegrationResponse.Builder,IntegrationResponse>

Method Summary

Modifier and Type	Method and Description
IntegrationResponse.Builder	contentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy) Supported only for WebSocket APIs.
IntegrationResponse.Builder	contentHandlingStrategy(String contentHandlingStrategy) Supported only for WebSocket APIs.
IntegrationResponse.Builder	integrationResponseId(String integrationResponseId) The integration response ID.
IntegrationResponse.Builder	integrationResponseKey(String integrationResponseKey) The integration response key.
IntegrationResponse.Builder	responseParameters(Map<String,String> responseParameters) A key-value map specifying response parameters that are passed to the method response from the backend.
IntegrationResponse.Builder	responseTemplates(Map<String,String> responseTemplates) The collection of response templates for the integration response as a string-to-string map of key-value pairs.
IntegrationResponse.Builder	templateSelectionExpression(String templateSelectionExpression) The template selection expressions for the integration response.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

contentHandlingStrategy

IntegrationResponse.Builder contentHandlingStrategy(String contentHandlingStrategy)

Supported only for WebSocket APIs. 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 route response or method response without modification.

Parameters:

contentHandlingStrategy - Supported only for WebSocket APIs. 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 route response or method response without modification.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentHandlingStrategy, ContentHandlingStrategy

contentHandlingStrategy

IntegrationResponse.Builder contentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy)

Supported only for WebSocket APIs. 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 route response or method response without modification.

Parameters:

contentHandlingStrategy - Supported only for WebSocket APIs. 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 route response or method response without modification.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentHandlingStrategy, ContentHandlingStrategy

integrationResponseId

IntegrationResponse.Builder integrationResponseId(String integrationResponseId)

The integration response ID.

Parameters:

integrationResponseId - The integration response ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

integrationResponseKey

IntegrationResponse.Builder integrationResponseKey(String integrationResponseKey)

The integration response key.

Parameters:

integrationResponseKey - The integration response key.

Returns:

Returns a reference to this object so that method calls can be chained together.

responseParameters

IntegrationResponse.Builder responseParameters(Map<String,String> responseParameters)

A key-value map specifying response parameters that are passed to the method response from the backend. 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.

Parameters:

responseParameters - A key-value map specifying response parameters that are passed to the method response from the backend. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

responseTemplates

IntegrationResponse.Builder responseTemplates(Map<String,String> responseTemplates)

The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Parameters:

responseTemplates - The collection of response templates for the integration response as a string-to-string map of key-value pairs. 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.

templateSelectionExpression

IntegrationResponse.Builder templateSelectionExpression(String templateSelectionExpression)

The template selection expressions for the integration response.

Parameters:

templateSelectionExpression - The template selection expressions for the integration response.

Returns:

Returns a reference to this object so that method calls can be chained together.