software.amazon.awssdk.services.apigatewayv2.model

Interface UpdateIntegrationResponse.Builder

All Superinterfaces:

ApiGatewayV2Response.Builder, AwsResponse.Builder, Buildable, CopyableBuilder<UpdateIntegrationResponse.Builder,UpdateIntegrationResponse>, SdkBuilder<UpdateIntegrationResponse.Builder,UpdateIntegrationResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

UpdateIntegrationResponse

public static interface UpdateIntegrationResponse.Builder
extends ApiGatewayV2Response.Builder, SdkPojo, CopyableBuilder<UpdateIntegrationResponse.Builder,UpdateIntegrationResponse>

Method Summary

Modifier and Type	Method and Description
UpdateIntegrationResponse.Builder	connectionId(String connectionId) The connection ID.
UpdateIntegrationResponse.Builder	connectionType(ConnectionType connectionType) The type of the network connection to the integration endpoint.
UpdateIntegrationResponse.Builder	connectionType(String connectionType) The type of the network connection to the integration endpoint.
UpdateIntegrationResponse.Builder	contentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy) Specifies how to handle response payload content type conversions.
UpdateIntegrationResponse.Builder	contentHandlingStrategy(String contentHandlingStrategy) Specifies how to handle response payload content type conversions.
UpdateIntegrationResponse.Builder	credentialsArn(String credentialsArn) Specifies the credentials required for the integration, if any.
UpdateIntegrationResponse.Builder	description(String description) Represents the description of an integration.
UpdateIntegrationResponse.Builder	integrationId(String integrationId) Represents the identifier of an integration.
UpdateIntegrationResponse.Builder	integrationMethod(String integrationMethod) Specifies the integration's HTTP method type.
UpdateIntegrationResponse.Builder	integrationResponseSelectionExpression(String integrationResponseSelectionExpression) The integration response selection expression for the integration.
UpdateIntegrationResponse.Builder	integrationType(IntegrationType integrationType) The integration type of an integration.
UpdateIntegrationResponse.Builder	integrationType(String integrationType) The integration type of an integration.
UpdateIntegrationResponse.Builder	integrationUri(String integrationUri) For a Lambda proxy integration, this is the URI of the Lambda function.
UpdateIntegrationResponse.Builder	passthroughBehavior(PassthroughBehavior passthroughBehavior) Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
UpdateIntegrationResponse.Builder	passthroughBehavior(String passthroughBehavior) Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
UpdateIntegrationResponse.Builder	requestParameters(Map<String,String> requestParameters) A key-value map specifying request parameters that are passed from the method request to the backend.
UpdateIntegrationResponse.Builder	requestTemplates(Map<String,String> requestTemplates) Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
UpdateIntegrationResponse.Builder	templateSelectionExpression(String templateSelectionExpression) The template selection expression for the integration.
UpdateIntegrationResponse.Builder	timeoutInMillis(Integer timeoutInMillis) Custom timeout between 50 and 29,000 milliseconds.

Methods inherited from interface software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

connectionId

UpdateIntegrationResponse.Builder connectionId(String connectionId)

The connection ID.

Parameters:

connectionId - The connection ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

connectionType

UpdateIntegrationResponse.Builder connectionType(String connectionType)

The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.

Parameters:

connectionType - The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectionType, ConnectionType

connectionType

UpdateIntegrationResponse.Builder connectionType(ConnectionType connectionType)

The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.

Parameters:

connectionType - The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ConnectionType, ConnectionType

contentHandlingStrategy

UpdateIntegrationResponse.Builder contentHandlingStrategy(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentHandlingStrategy, ContentHandlingStrategy

contentHandlingStrategy

UpdateIntegrationResponse.Builder contentHandlingStrategy(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentHandlingStrategy, ContentHandlingStrategy

credentialsArn

UpdateIntegrationResponse.Builder credentialsArn(String credentialsArn)

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Parameters:

credentialsArn - Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

UpdateIntegrationResponse.Builder description(String description)

Represents the description of an integration.

Parameters:

description - Represents the description of an integration.

Returns:

Returns a reference to this object so that method calls can be chained together.

integrationId

UpdateIntegrationResponse.Builder integrationId(String integrationId)

Represents the identifier of an integration.

Parameters:

integrationId - Represents the identifier of an integration.

Returns:

Returns a reference to this object so that method calls can be chained together.

integrationMethod

UpdateIntegrationResponse.Builder integrationMethod(String integrationMethod)

Specifies the integration's HTTP method type.

Parameters:

integrationMethod - Specifies the integration's HTTP method type.

Returns:

Returns a reference to this object so that method calls can be chained together.

integrationResponseSelectionExpression

UpdateIntegrationResponse.Builder integrationResponseSelectionExpression(String integrationResponseSelectionExpression)

The integration response selection expression for the integration. See Integration Response Selection Expressions.

Parameters:

integrationResponseSelectionExpression - The integration response selection expression for the integration. See Integration Response Selection Expressions.

Returns:

Returns a reference to this object so that method calls can be chained together.

integrationType

UpdateIntegrationResponse.Builder integrationType(String integrationType)

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.

HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

Parameters:

integrationType - The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.

HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IntegrationType, IntegrationType

integrationType

UpdateIntegrationResponse.Builder integrationType(IntegrationType integrationType)

The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.

HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

Parameters:

integrationType - The integration type of an integration. One of the following:

AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.

HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration.

HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.

MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IntegrationType, IntegrationType

integrationUri

UpdateIntegrationResponse.Builder integrationUri(String integrationUri)

For a Lambda proxy integration, this is the URI of the Lambda function.

Parameters:

integrationUri - For a Lambda proxy integration, this is the URI of the Lambda function.

Returns:

Returns a reference to this object so that method calls can be chained together.

passthroughBehavior

UpdateIntegrationResponse.Builder passthroughBehavior(String passthroughBehavior)

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

Parameters:

passthroughBehavior - Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PassthroughBehavior, PassthroughBehavior

passthroughBehavior

UpdateIntegrationResponse.Builder passthroughBehavior(PassthroughBehavior passthroughBehavior)

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

Parameters:

passthroughBehavior - Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.

WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PassthroughBehavior, PassthroughBehavior

requestParameters

UpdateIntegrationResponse.Builder requestParameters(Map<String,String> requestParameters)

A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.

Parameters:

requestParameters - A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestTemplates

UpdateIntegrationResponse.Builder requestTemplates(Map<String,String> requestTemplates)

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Parameters:

requestTemplates - Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Returns:

Returns a reference to this object so that method calls can be chained together.

templateSelectionExpression

UpdateIntegrationResponse.Builder templateSelectionExpression(String templateSelectionExpression)

The template selection expression for the integration.

Parameters:

templateSelectionExpression - The template selection expression for the integration.

Returns:

Returns a reference to this object so that method calls can be chained together.

timeoutInMillis

UpdateIntegrationResponse.Builder timeoutInMillis(Integer timeoutInMillis)

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Parameters:

timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

Returns:

Returns a reference to this object so that method calls can be chained together.