software.amazon.awssdk.services.apigatewayv2.model

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(value="software.amazon.awssdk:codegen")
public final class UpdateIntegrationResponseRequest
extends ApiGatewayV2Request
implements ToCopyableBuilder<UpdateIntegrationResponseRequest.Builder,UpdateIntegrationResponseRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateIntegrationResponseRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	apiId() The API identifier.
static UpdateIntegrationResponseRequest.Builder	builder()
ContentHandlingStrategy	contentHandlingStrategy() Specifies how to handle response payload content type conversions.
String	contentHandlingStrategyAsString() 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()
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()
String	toString() 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 String apiId()

The API identifier.

Returns:

The API identifier.

contentHandlingStrategy

public ContentHandlingStrategy contentHandlingStrategy()

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:

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

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:

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

The integration ID.

Returns:

The integration ID.

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.

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.

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.

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.

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 expression for the integration response.

Returns:

The template selection expression for the integration response.

toBuilder

public UpdateIntegrationResponseRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateIntegrationResponseRequest.Builder,UpdateIntegrationResponseRequest>

Specified by:

toBuilder in class ApiGatewayV2Request

builder

public static UpdateIntegrationResponseRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo