@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) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasResponseParameters()
For responses, this returns true if the service returned a value for the ResponseParameters property.
|
boolean |
hasResponseTemplates()
For responses, this returns true if the service returned a value for the ResponseTemplates property.
|
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.
|
List<SdkField<?>> |
sdkFields() |
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() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String statusCode()
Specifies the status code that is used to map the integration response to an existing MethodResponse.
public final 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.
.+ 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 final boolean hasResponseParameters()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasResponseParameters() method.
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 final boolean hasResponseTemplates()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasResponseTemplates() method.
public final 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.
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:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
ContentHandlingStrategypublic final 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:
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:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
ContentHandlingStrategypublic GetIntegrationResponseResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<GetIntegrationResponseResponse.Builder,GetIntegrationResponseResponse>toBuilder in class AwsResponsepublic static GetIntegrationResponseResponse.Builder builder()
public static Class<? extends GetIntegrationResponseResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.