Class UpdateIntegrationResponseRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request
-
- software.amazon.awssdk.services.apigatewayv2.model.UpdateIntegrationResponseRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateIntegrationResponseRequest.Builder,UpdateIntegrationResponseRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateIntegrationResponseRequest extends ApiGatewayV2Request implements ToCopyableBuilder<UpdateIntegrationResponseRequest.Builder,UpdateIntegrationResponseRequest>
Updates an IntegrationResponses.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateIntegrationResponseRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringapiId()The API identifier.static UpdateIntegrationResponseRequest.Builderbuilder()ContentHandlingStrategycontentHandlingStrategy()Supported only for WebSocket APIs.StringcontentHandlingStrategyAsString()Supported only for WebSocket APIs.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasResponseParameters()For responses, this returns true if the service returned a value for the ResponseParameters property.booleanhasResponseTemplates()For responses, this returns true if the service returned a value for the ResponseTemplates property.StringintegrationId()The integration ID.StringintegrationResponseId()The integration response ID.StringintegrationResponseKey()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()StringtemplateSelectionExpression()The template selection expression for the integration response.UpdateIntegrationResponseRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
apiId
public final String apiId()
The API identifier.
- Returns:
- The API identifier.
-
contentHandlingStrategy
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,
contentHandlingStrategywill returnContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcontentHandlingStrategyAsString().- Returns:
- 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.
- See Also:
ContentHandlingStrategy
-
contentHandlingStrategyAsString
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,
contentHandlingStrategywill returnContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcontentHandlingStrategyAsString().- Returns:
- 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.
- See Also:
ContentHandlingStrategy
-
integrationId
public final String integrationId()
The integration ID.
- Returns:
- The integration ID.
-
integrationResponseId
public final String integrationResponseId()
The integration response ID.
- Returns:
- The integration response ID.
-
integrationResponseKey
public final String integrationResponseKey()
The integration response key.
- Returns:
- The integration response key.
-
hasResponseParameters
public final boolean hasResponseParameters()
For responses, this returns true if the service returned a value for the ResponseParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
responseParameters
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.
{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.- Returns:
- 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.
-
hasResponseTemplates
public final boolean hasResponseTemplates()
For responses, this returns true if the service returned a value for the ResponseTemplates property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
responseTemplates
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.
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.- Returns:
- 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.
-
templateSelectionExpression
public final String templateSelectionExpression()
The template selection expression for the integration response. Supported only for WebSocket APIs.
- Returns:
- The template selection expression for the integration response. Supported only for WebSocket APIs.
-
toBuilder
public UpdateIntegrationResponseRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateIntegrationResponseRequest.Builder,UpdateIntegrationResponseRequest>- Specified by:
toBuilderin classApiGatewayV2Request
-
builder
public static UpdateIntegrationResponseRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateIntegrationResponseRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-