software.amazon.awssdk.services.apigatewayv2.model

Class UpdateIntegrationResponseResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response

software.amazon.awssdk.services.apigatewayv2.model.UpdateIntegrationResponseResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateIntegrationResponseResponse.Builder,UpdateIntegrationResponseResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateIntegrationResponseResponse
extends ApiGatewayV2Response
implements ToCopyableBuilder<UpdateIntegrationResponseResponse.Builder,UpdateIntegrationResponseResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateIntegrationResponseResponse.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateIntegrationResponseResponse.Builder	builder()
ContentHandlingStrategy	contentHandlingStrategy() Supported only for WebSocket APIs.
String	contentHandlingStrategyAsString() Supported only for WebSocket APIs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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	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 UpdateIntegrationResponseResponse.Builder>	serializableBuilderClass()
String	templateSelectionExpression() The template selection expressions for the integration response.
UpdateIntegrationResponseResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

contentHandlingStrategy

public 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().

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 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().

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

integrationResponseId

public String integrationResponseId()

The integration response ID.

Returns:

The integration response ID.

integrationResponseKey

public String integrationResponseKey()

The integration response key.

Returns:

The integration response key.

hasResponseParameters

public 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). For responses returned by the SDK, the sender is the AWS service.

responseParameters

public 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.

You can use hasResponseParameters() to see if a value was sent in this field.

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 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). For responses returned by the SDK, the sender is the AWS service.

responseTemplates

public 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.

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 String templateSelectionExpression()

The template selection expressions for the integration response.

Returns:

The template selection expressions for the integration response.

toBuilder

public UpdateIntegrationResponseResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateIntegrationResponseResponse.Builder,UpdateIntegrationResponseResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static UpdateIntegrationResponseResponse.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateIntegrationResponseResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo