@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetIntegrationResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
GetIntegrationResponseResult() |
Modifier and Type | Method and Description |
---|---|
GetIntegrationResponseResult |
addResponseParametersEntry(String key,
String value)
Add a single ResponseParameters entry
|
GetIntegrationResponseResult |
addResponseTemplatesEntry(String key,
String value)
Add a single ResponseTemplates entry
|
GetIntegrationResponseResult |
clearResponseParametersEntries()
Removes all the entries added into ResponseParameters.
|
GetIntegrationResponseResult |
clearResponseTemplatesEntries()
Removes all the entries added into ResponseTemplates.
|
GetIntegrationResponseResult |
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 |
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.
|
GetIntegrationResponseResult |
withContentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy)
Supported only for WebSocket APIs.
|
GetIntegrationResponseResult |
withContentHandlingStrategy(String contentHandlingStrategy)
Supported only for WebSocket APIs.
|
GetIntegrationResponseResult |
withIntegrationResponseId(String integrationResponseId)
The integration response ID.
|
GetIntegrationResponseResult |
withIntegrationResponseKey(String integrationResponseKey)
The integration response key.
|
GetIntegrationResponseResult |
withResponseParameters(Map<String,String> responseParameters)
A key-value map specifying response parameters that are passed to the method response from the backend.
|
GetIntegrationResponseResult |
withResponseTemplates(Map<String,String> responseTemplates)
The collection of response templates for the integration response as a string-to-string map of key-value pairs.
|
GetIntegrationResponseResult |
withTemplateSelectionExpression(String templateSelectionExpression)
The template selection expressions for the integration response.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
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.
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.
ContentHandlingStrategy
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.
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.
ContentHandlingStrategy
public GetIntegrationResponseResult 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.
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.
ContentHandlingStrategy
public GetIntegrationResponseResult 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.
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.
ContentHandlingStrategy
public void setIntegrationResponseId(String integrationResponseId)
The integration response ID.
integrationResponseId
- The integration response ID.public String getIntegrationResponseId()
The integration response ID.
public GetIntegrationResponseResult withIntegrationResponseId(String integrationResponseId)
The integration response ID.
integrationResponseId
- The integration response ID.public void setIntegrationResponseKey(String integrationResponseKey)
The integration response key.
integrationResponseKey
- The integration response key.public String getIntegrationResponseKey()
The integration response key.
public GetIntegrationResponseResult withIntegrationResponseKey(String integrationResponseKey)
The integration response key.
integrationResponseKey
- The integration response key.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.
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.
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.public GetIntegrationResponseResult 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.
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.public GetIntegrationResponseResult addResponseParametersEntry(String key, String value)
public GetIntegrationResponseResult clearResponseParametersEntries()
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.
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.
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.public GetIntegrationResponseResult 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.
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.public GetIntegrationResponseResult addResponseTemplatesEntry(String key, String value)
public GetIntegrationResponseResult clearResponseTemplatesEntries()
public void setTemplateSelectionExpression(String templateSelectionExpression)
The template selection expressions for the integration response.
templateSelectionExpression
- The template selection expressions for the integration response.public String getTemplateSelectionExpression()
The template selection expressions for the integration response.
public GetIntegrationResponseResult withTemplateSelectionExpression(String templateSelectionExpression)
The template selection expressions for the integration response.
templateSelectionExpression
- The template selection expressions for the integration response.public String toString()
toString
in class Object
Object.toString()
public GetIntegrationResponseResult clone()