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

Class UpdateIntegrationResponseResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.apigateway.model.UpdateIntegrationResponseResponse

All Implemented Interfaces:

ToCopyableBuilder<UpdateIntegrationResponseResponse.Builder,UpdateIntegrationResponseResponse>

@Generated("software.amazon.awssdk:codegen")
public class UpdateIntegrationResponseResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<UpdateIntegrationResponseResponse.Builder,UpdateIntegrationResponseResponse>

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

Creating an API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateIntegrationResponseResponse.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateIntegrationResponseResponse.Builder	builder()
String	contentHandling()	Specifies how to handle response payload content type conversions.
boolean	equals(Object obj)
int	hashCode()
Map<String,String>	responseParameters()	A key-value map specifying response parameters that are passed to the method response from the back end.
Map<String,String>	responseTemplates()	Specifies the templates used to transform the integration response body.
String	selectionPattern()	Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.
static Class<? extends UpdateIntegrationResponseResponse.Builder>	serializableBuilderClass()
String	statusCode()	Specifies the status code that is used to map the integration response to an existing MethodResponse.
UpdateIntegrationResponseResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

statusCode

public String statusCode()

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

Returns:

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

selectionPattern

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

Returns:

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.

responseParameters

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

Returns:

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.

responseTemplates

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

Returns:

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.

contentHandling

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

Returns:

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.

See Also:

ContentHandlingStrategy

toBuilder

public UpdateIntegrationResponseResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateIntegrationResponseResponse.Builder,UpdateIntegrationResponseResponse>

Returns:

a builder for type T

builder

public static UpdateIntegrationResponseResponse.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateIntegrationResponseResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object