com.amazonaws.services.apigatewayv2.model

Class IntegrationResponse

java.lang.Object

com.amazonaws.services.apigatewayv2.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.

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	getContentHandlingStrategy() Supported only for WebSocket APIs.
String	getIntegrationResponseId() The integration response ID.
String	getIntegrationResponseKey() The integration response key.
Map<String,String>	getResponseParameters() A key-value map specifying response parameters that are passed to the method response from the backend.
Map<String,String>	getResponseTemplates() The collection of response templates for the integration response as a string-to-string map of key-value pairs.
String	getTemplateSelectionExpression() The template selection expressions for the integration response.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setContentHandlingStrategy(String contentHandlingStrategy) Supported only for WebSocket APIs.
void	setIntegrationResponseId(String integrationResponseId) The integration response ID.
void	setIntegrationResponseKey(String integrationResponseKey) The integration response key.
void	setResponseParameters(Map<String,String> responseParameters) A key-value map specifying response parameters that are passed to the method response from the backend.
void	setResponseTemplates(Map<String,String> responseTemplates) The collection of response templates for the integration response as a string-to-string map of key-value pairs.
void	setTemplateSelectionExpression(String templateSelectionExpression) The template selection expressions for the integration response.
String	toString() Returns a string representation of this object.
IntegrationResponse	withContentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy) Supported only for WebSocket APIs.
IntegrationResponse	withContentHandlingStrategy(String contentHandlingStrategy) Supported only for WebSocket APIs.
IntegrationResponse	withIntegrationResponseId(String integrationResponseId) The integration response ID.
IntegrationResponse	withIntegrationResponseKey(String integrationResponseKey) The integration response key.
IntegrationResponse	withResponseParameters(Map<String,String> responseParameters) A key-value map specifying response parameters that are passed to the method response from the backend.
IntegrationResponse	withResponseTemplates(Map<String,String> responseTemplates) The collection of response templates for the integration response as a string-to-string map of key-value pairs.
IntegrationResponse	withTemplateSelectionExpression(String templateSelectionExpression) The template selection expressions for the integration response.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntegrationResponse

public IntegrationResponse()

Method Detail

setContentHandlingStrategy

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

See Also:

ContentHandlingStrategy

getContentHandlingStrategy

public String getContentHandlingStrategy()

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:

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.

See Also:

ContentHandlingStrategy

withContentHandlingStrategy

public IntegrationResponse withContentHandlingStrategy(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

withContentHandlingStrategy

public IntegrationResponse withContentHandlingStrategy(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

setIntegrationResponseId

public void setIntegrationResponseId(String integrationResponseId)

The integration response ID.

Parameters:

integrationResponseId - The integration response ID.

getIntegrationResponseId

public String getIntegrationResponseId()

The integration response ID.

Returns:

The integration response ID.

withIntegrationResponseId

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

setIntegrationResponseKey

public void setIntegrationResponseKey(String integrationResponseKey)

The integration response key.

Parameters:

integrationResponseKey - The integration response key.

getIntegrationResponseKey

public String getIntegrationResponseKey()

The integration response key.

Returns:

The integration response key.

withIntegrationResponseKey

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

getResponseParameters

public Map<String,String> getResponseParameters()

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:

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.

setResponseParameters

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

withResponseParameters

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

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()

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:

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.

setResponseTemplates

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

withResponseTemplates

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

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.

setTemplateSelectionExpression

public void setTemplateSelectionExpression(String templateSelectionExpression)

The template selection expressions for the integration response.

Parameters:

templateSelectionExpression - The template selection expressions for the integration response.

getTemplateSelectionExpression

public String getTemplateSelectionExpression()

The template selection expressions for the integration response.

Returns:

The template selection expressions for the integration response.

withTemplateSelectionExpression

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

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.