@Generated(value="software.amazon.awssdk:codegen") public final class GetIntegrationResponseResponse extends ApiGatewayResponse implements ToCopyableBuilder<GetIntegrationResponseResponse.Builder,GetIntegrationResponseResponse>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
GetIntegrationResponseResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static GetIntegrationResponseResponse.Builder |
builder() |
ContentHandlingStrategy |
contentHandling()
Specifies how to handle response payload content type conversions.
|
String |
contentHandlingAsString()
Specifies how to handle response payload content type conversions.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
Map<String,String> |
responseParameters()
A key-value map specifying response parameters that are passed to the method response from the back end.
|
Map<String,String> |
responseTemplates()
Specifies the templates used to transform the integration response body.
|
String |
selectionPattern()
Specifies the regular expression (regex) pattern used to choose an integration response based on the response
from the back end.
|
static Class<? extends GetIntegrationResponseResponse.Builder> |
serializableBuilderClass() |
String |
statusCode()
Specifies the status code that is used to map the integration response to an existing MethodResponse.
|
GetIntegrationResponseResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
sdkHttpResponse
copy
public String statusCode()
Specifies the status code that is used to map the integration response to an existing MethodResponse.
public 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 AWS Lambda
function, the AWS Lambda function error header is matched. For all other HTTP and AWS 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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP
and AWS back ends, the HTTP status code is matched.public 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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:
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 method response without modification.
If the service returns an enum value that is not available in the current SDK version, contentHandling
will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from contentHandlingAsString()
.
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 method response without modification.
ContentHandlingStrategy
public String contentHandlingAsString()
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 method response without modification.
If the service returns an enum value that is not available in the current SDK version, contentHandling
will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from contentHandlingAsString()
.
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 method response without modification.
ContentHandlingStrategy
public GetIntegrationResponseResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetIntegrationResponseResponse.Builder,GetIntegrationResponseResponse>
toBuilder
in class AwsResponse
public static GetIntegrationResponseResponse.Builder builder()
public static Class<? extends GetIntegrationResponseResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.