@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.
Constructor and Description |
---|
IntegrationResponse() |
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.
|
public void setStatusCode(String statusCode)
Specifies the status code that is used to map the integration response to an existing MethodResponse.
statusCode
- Specifies the status code that is used to map the integration response to an existing MethodResponse.public String getStatusCode()
Specifies the status code that is used to map the integration response to an existing MethodResponse.
public IntegrationResponse withStatusCode(String statusCode)
Specifies the status code that is used to map the integration response to an existing MethodResponse.
statusCode
- Specifies the status code that is used to map the integration response to an existing MethodResponse.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.
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.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.
.+
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.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.
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.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.
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 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.
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.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.
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.public IntegrationResponse addResponseParametersEntry(String key, String value)
public IntegrationResponse clearResponseParametersEntries()
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.
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.
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.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.
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.public IntegrationResponse addResponseTemplatesEntry(String key, String value)
public IntegrationResponse clearResponseTemplatesEntries()
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.
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.
ContentHandlingStrategy
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.
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.
ContentHandlingStrategy
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.
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.
ContentHandlingStrategy
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.
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.
ContentHandlingStrategy
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.
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.
ContentHandlingStrategy
public String toString()
toString
in class Object
Object.toString()
public IntegrationResponse clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.