Package software.amazon.awssdk.services.apigateway.model

Interface PutIntegrationResponseRequest.Builder

All Superinterfaces:

CopyableBuilder<PutIntegrationResponseRequest.Builder,PutIntegrationResponseRequest>, SdkBuilder<PutIntegrationResponseRequest.Builder,PutIntegrationResponseRequest>

Enclosing class:

PutIntegrationResponseRequest

public static interface PutIntegrationResponseRequest.Builder
extends CopyableBuilder<PutIntegrationResponseRequest.Builder,PutIntegrationResponseRequest>

Method Summary

Modifier and Type	Method	Description
PutIntegrationResponseRequest.Builder	contentHandling(String contentHandling)	Specifies how to handle response payload content type conversions.
PutIntegrationResponseRequest.Builder	contentHandling(ContentHandlingStrategy 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	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)	Specifies a put integration response request's API identifier.
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.

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

copy

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

apply, build

Method Detail

restApiId

PutIntegrationResponseRequest.Builder restApiId(String restApiId)

Specifies a put integration response request's API identifier.

Parameters:

restApiId - Specifies a put integration response request's API identifier.

Returns:

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

resourceId

PutIntegrationResponseRequest.Builder resourceId(String resourceId)

Specifies a put integration response request's resource identifier.

Parameters:

resourceId - Specifies a put integration response request's resource identifier.

Returns:

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

httpMethod

PutIntegrationResponseRequest.Builder httpMethod(String httpMethod)

Specifies a put integration response request's HTTP method.

Parameters:

httpMethod - Specifies a put integration response request's HTTP method.

Returns:

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

statusCode

PutIntegrationResponseRequest.Builder statusCode(String statusCode)

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Parameters:

statusCode - 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

PutIntegrationResponseRequest.Builder selectionPattern(String selectionPattern)

Specifies the selection pattern of a put integration response.

Parameters:

selectionPattern - Specifies the selection pattern of a put integration response.

Returns:

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

responseParameters

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.

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 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.

Returns:

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

responseTemplates

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

Specifies a put integration response's templates.

Parameters:

responseTemplates - Specifies a put integration response's templates.

Returns:

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

contentHandling

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.

Parameters:

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.

Returns:

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

See Also:

ContentHandlingStrategy

contentHandling

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.

Parameters:

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.

Returns:

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

See Also:

ContentHandlingStrategy