@Generated(value="software.amazon.awssdk:codegen") public final class UpdateIntegrationResponseRequest extends ApiGatewayV2Request implements ToCopyableBuilder<UpdateIntegrationResponseRequest.Builder,UpdateIntegrationResponseRequest>
Updates an IntegrationResponses.
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateIntegrationResponseRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
apiId()
The API identifier.
|
static UpdateIntegrationResponseRequest.Builder |
builder() |
ContentHandlingStrategy |
contentHandlingStrategy()
Supported only for WebSocket APIs.
|
String |
contentHandlingStrategyAsString()
Supported only for WebSocket APIs.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
boolean |
hasResponseParameters()
Returns true if the ResponseParameters property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasResponseTemplates()
Returns true if the ResponseTemplates property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
String |
integrationId()
The integration ID.
|
String |
integrationResponseId()
The integration response ID.
|
String |
integrationResponseKey()
The integration response key.
|
Map<String,String> |
responseParameters()
A key-value map specifying response parameters that are passed to the method response from the backend.
|
Map<String,String> |
responseTemplates()
The collection of response templates for the integration response as a string-to-string map of key-value pairs.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateIntegrationResponseRequest.Builder> |
serializableBuilderClass() |
String |
templateSelectionExpression()
The template selection expression for the integration response.
|
UpdateIntegrationResponseRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String apiId()
The API identifier.
public final 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.
If the service returns an enum value that is not available in the current SDK version,
contentHandlingStrategy
will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from contentHandlingStrategyAsString()
.
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 final String contentHandlingStrategyAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
contentHandlingStrategy
will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from contentHandlingStrategyAsString()
.
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 final String integrationId()
The integration ID.
public final String integrationResponseId()
The integration response ID.
public final String integrationResponseKey()
The integration response key.
public final boolean hasResponseParameters()
public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasResponseParameters()
to see if a value was sent in this field.
public final boolean hasResponseTemplates()
public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasResponseTemplates()
to see if a value was sent in this field.
public final String templateSelectionExpression()
The template selection expression for the integration response. Supported only for WebSocket APIs.
public UpdateIntegrationResponseRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateIntegrationResponseRequest.Builder,UpdateIntegrationResponseRequest>
toBuilder
in class ApiGatewayV2Request
public static UpdateIntegrationResponseRequest.Builder builder()
public static Class<? extends UpdateIntegrationResponseRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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 SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.