com.amazonaws.services.apigateway.model

Class IntegrationResponse

java.lang.Object

com.amazonaws.services.apigateway.model.IntegrationResponse

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IntegrationResponse
extends Object
implements Serializable, Cloneable, StructuredPojo

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IntegrationResponse()

Method Summary

Modifier and Type	Method and Description
IntegrationResponse	addResponseParametersEntry(String key, String value) Add a single ResponseParameters entry
IntegrationResponse	addResponseTemplatesEntry(String key, String value) Add a single ResponseTemplates entry
IntegrationResponse	clearResponseParametersEntries() Removes all the entries added into ResponseParameters.
IntegrationResponse	clearResponseTemplatesEntries() Removes all the entries added into ResponseTemplates.
IntegrationResponse	clone()
boolean	equals(Object obj)
String	getContentHandling() Specifies how to handle response payload content type conversions.
Map<String,String>	getResponseParameters() A key-value map specifying response parameters that are passed to the method response from the back end.
Map<String,String>	getResponseTemplates() Specifies the templates used to transform the integration response body.
String	getSelectionPattern() Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.
String	getStatusCode() Specifies the status code that is used to map the integration response to an existing MethodResponse.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setContentHandling(ContentHandlingStrategy contentHandling) Specifies how to handle response payload content type conversions.
void	setContentHandling(String contentHandling) Specifies how to handle response payload content type conversions.
void	setResponseParameters(Map<String,String> responseParameters) A key-value map specifying response parameters that are passed to the method response from the back end.
void	setResponseTemplates(Map<String,String> responseTemplates) Specifies the templates used to transform the integration response body.
void	setSelectionPattern(String selectionPattern) Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.
void	setStatusCode(String statusCode) Specifies the status code that is used to map the integration response to an existing MethodResponse.
String	toString() Returns a string representation of this object.
IntegrationResponse	withContentHandling(ContentHandlingStrategy contentHandling) Specifies how to handle response payload content type conversions.
IntegrationResponse	withContentHandling(String contentHandling) Specifies how to handle response payload content type conversions.
IntegrationResponse	withResponseParameters(Map<String,String> responseParameters) A key-value map specifying response parameters that are passed to the method response from the back end.
IntegrationResponse	withResponseTemplates(Map<String,String> responseTemplates) Specifies the templates used to transform the integration response body.
IntegrationResponse	withSelectionPattern(String selectionPattern) Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end.
IntegrationResponse	withStatusCode(String statusCode) Specifies the status code that is used to map the integration response to an existing MethodResponse.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntegrationResponse

public IntegrationResponse()

Method Detail

setStatusCode

public void setStatusCode(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.

getStatusCode

public String getStatusCode()

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.

withStatusCode

public IntegrationResponse withStatusCode(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.

setSelectionPattern

public void setSelectionPattern(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 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.

getSelectionPattern

public String getSelectionPattern()

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:

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.

withSelectionPattern

public IntegrationResponse withSelectionPattern(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 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.

getResponseParameters

public Map<String,String> getResponseParameters()

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.

setResponseParameters

public void setResponseParameters(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.

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 is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

withResponseParameters

public IntegrationResponse withResponseParameters(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.

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

addResponseParametersEntry

public IntegrationResponse addResponseParametersEntry(String key,
                                                      String value)

Add a single ResponseParameters entry

See Also:

withResponseParameters(java.util.Map<java.lang.String, java.lang.String>)

clearResponseParametersEntries

public IntegrationResponse clearResponseParametersEntries()

Removes all the entries added into ResponseParameters.

Returns:

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

getResponseTemplates

public Map<String,String> getResponseTemplates()

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.

setResponseTemplates

public void setResponseTemplates(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.

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.

withResponseTemplates

public IntegrationResponse withResponseTemplates(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.

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.

addResponseTemplatesEntry

public IntegrationResponse addResponseTemplatesEntry(String key,
                                                     String value)

Add a single ResponseTemplates entry

See Also:

withResponseTemplates(java.util.Map<java.lang.String, java.lang.String>)

clearResponseTemplatesEntries

public IntegrationResponse clearResponseTemplatesEntries()

Removes all the entries added into ResponseTemplates.

Returns:

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

setContentHandling

public void setContentHandling(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:

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:

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

getContentHandling

public String getContentHandling()

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_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:

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_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.

See Also:

ContentHandlingStrategy

withContentHandling

public IntegrationResponse withContentHandling(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:

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:

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

setContentHandling

public void setContentHandling(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:

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:

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

withContentHandling

public IntegrationResponse withContentHandling(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:

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:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public IntegrationResponse clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.