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>

Updates an IntegrationResponses.

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

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

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

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.

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

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateIntegrationResponseRequest.Builder,UpdateIntegrationResponseRequest>

Specified by:

toBuilder in class ApiGatewayV2Request

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.