com.amazonaws.services.apigatewayv2.model

Class CreateIntegrationResponseRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigatewayv2.model.CreateIntegrationResponseRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Creates a new IntegrationResponse resource to represent an integration response.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateIntegrationResponseRequest()

Method Summary

Modifier and Type	Method and Description
CreateIntegrationResponseRequest	addResponseParametersEntry(String key, String value) Add a single ResponseParameters entry
CreateIntegrationResponseRequest	addResponseTemplatesEntry(String key, String value) Add a single ResponseTemplates entry
CreateIntegrationResponseRequest	clearResponseParametersEntries() Removes all the entries added into ResponseParameters.
CreateIntegrationResponseRequest	clearResponseTemplatesEntries() Removes all the entries added into ResponseTemplates.
CreateIntegrationResponseRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApiId() The API identifier.
String	getContentHandlingStrategy() Specifies how to handle response payload content type conversions.
String	getIntegrationId() The integration 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 expression for the integration response.
int	hashCode()
void	setApiId(String apiId) The API identifier.
void	setContentHandlingStrategy(String contentHandlingStrategy) Specifies how to handle response payload content type conversions.
void	setIntegrationId(String integrationId) The integration 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 expression for the integration response.
String	toString() Returns a string representation of this object.
CreateIntegrationResponseRequest	withApiId(String apiId) The API identifier.
CreateIntegrationResponseRequest	withContentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy) Specifies how to handle response payload content type conversions.
CreateIntegrationResponseRequest	withContentHandlingStrategy(String contentHandlingStrategy) Specifies how to handle response payload content type conversions.
CreateIntegrationResponseRequest	withIntegrationId(String integrationId) The integration ID.
CreateIntegrationResponseRequest	withIntegrationResponseKey(String integrationResponseKey) The integration response key.
CreateIntegrationResponseRequest	withResponseParameters(Map<String,String> responseParameters) A key-value map specifying response parameters that are passed to the method response from the backend.
CreateIntegrationResponseRequest	withResponseTemplates(Map<String,String> responseTemplates) The collection of response templates for the integration response as a string-to-string map of key-value pairs.
CreateIntegrationResponseRequest	withTemplateSelectionExpression(String templateSelectionExpression) The template selection expression for the integration response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateIntegrationResponseRequest

public CreateIntegrationResponseRequest()

Method Detail

setApiId

public void setApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

getApiId

public String getApiId()

The API identifier.

Returns:

The API identifier.

withApiId

public CreateIntegrationResponseRequest withApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

Returns:

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

setContentHandlingStrategy

public void setContentHandlingStrategy(String contentHandlingStrategy)

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

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:

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 CreateIntegrationResponseRequest withContentHandlingStrategy(String contentHandlingStrategy)

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 - 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 CreateIntegrationResponseRequest withContentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy)

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

setIntegrationId

public void setIntegrationId(String integrationId)

The integration ID.

Parameters:

integrationId - The integration ID.

getIntegrationId

public String getIntegrationId()

The integration ID.

Returns:

The integration ID.

withIntegrationId

public CreateIntegrationResponseRequest withIntegrationId(String integrationId)

The integration ID.

Parameters:

integrationId - The integration 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 CreateIntegrationResponseRequest 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 CreateIntegrationResponseRequest 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 CreateIntegrationResponseRequest addResponseParametersEntry(String key,
                                                                   String value)

Add a single ResponseParameters entry

See Also:

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

clearResponseParametersEntries

public CreateIntegrationResponseRequest 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 CreateIntegrationResponseRequest 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 CreateIntegrationResponseRequest addResponseTemplatesEntry(String key,
                                                                  String value)

Add a single ResponseTemplates entry

See Also:

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

clearResponseTemplatesEntries

public CreateIntegrationResponseRequest 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 expression for the integration response. Supported only for WebSocket APIs.

Parameters:

templateSelectionExpression - The template selection expression for the integration response. Supported only for WebSocket APIs.

getTemplateSelectionExpression

public String getTemplateSelectionExpression()

The template selection expression for the integration response. Supported only for WebSocket APIs.

Returns:

The template selection expression for the integration response. Supported only for WebSocket APIs.

withTemplateSelectionExpression

public CreateIntegrationResponseRequest withTemplateSelectionExpression(String templateSelectionExpression)

The template selection expression for the integration response. Supported only for WebSocket APIs.

Parameters:

templateSelectionExpression - The template selection expression for the integration response. Supported only for WebSocket APIs.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()