software.amazon.awssdk.services.apigateway.model

Class PutIntegrationResponseRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

software.amazon.awssdk.services.apigateway.model.PutIntegrationResponseRequest

All Implemented Interfaces:

ToCopyableBuilder<PutIntegrationResponseRequest.Builder,PutIntegrationResponseRequest>

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

Represents a put integration response request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutIntegrationResponseRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutIntegrationResponseRequest.Builder	builder()
ContentHandlingStrategy	contentHandling() Specifies how to handle response payload content type conversions.
String	contentHandlingAsString() Specifies how to handle response payload content type conversions.
boolean	equals(Object obj)
<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()
String	httpMethod() Specifies a put integration response request's HTTP method.
String	resourceId() Specifies a put integration response request's resource identifier.
Map<String,String>	responseParameters() A key-value map specifying response parameters that are passed to the method response from the back end.
Map<String,String>	responseTemplates() Specifies a put integration response's templates.
String	restApiId() The string identifier of the associated RestApi.
String	selectionPattern() Specifies the selection pattern of a put integration response.
static Class<? extends PutIntegrationResponseRequest.Builder>	serializableBuilderClass()
String	statusCode() Specifies the status code that is used to map the integration response to an existing MethodResponse.
PutIntegrationResponseRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

restApiId

public String restApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

resourceId

public String resourceId()

Specifies a put integration response request's resource identifier.

Returns:

Specifies a put integration response request's resource identifier.

httpMethod

public String httpMethod()

Specifies a put integration response request's HTTP method.

Returns:

Specifies a put integration response request's HTTP method.

statusCode

public String statusCode()

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Returns:

Specifies the status code that is used to map the integration response to an existing MethodResponse.

selectionPattern

public String selectionPattern()

Specifies the selection pattern of a put integration response.

Returns:

Specifies the selection pattern of a put integration response.

responseParameters

public Map<String,String> responseParameters()

A key-value map specifying response parameters that are passed to the method response from the back end. 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 must be a valid and unique response header name and JSON-expression 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 back end. 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 must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

responseTemplates

public Map<String,String> responseTemplates()

Specifies a put integration response's templates.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Specifies a put integration response's templates.

contentHandling

public ContentHandlingStrategy contentHandling()

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 method response without modification.

If the service returns an enum value that is not available in the current SDK version, contentHandling will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentHandlingAsString().

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 method response without modification.

See Also:

ContentHandlingStrategy

contentHandlingAsString

public String contentHandlingAsString()

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 method response without modification.

If the service returns an enum value that is not available in the current SDK version, contentHandling will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentHandlingAsString().

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 method response without modification.

See Also:

ContentHandlingStrategy

toBuilder

public PutIntegrationResponseRequest.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<PutIntegrationResponseRequest.Builder,PutIntegrationResponseRequest>

Specified by:

toBuilder in class ApiGatewayRequest

Returns:

a builder for type T

builder

public static PutIntegrationResponseRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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