com.amazonaws.services.apigatewayv2.model

Class UpdateIntegrationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigatewayv2.model.UpdateIntegrationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateIntegrationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Updates an Integration.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateIntegrationRequest()

Method Summary

Modifier and Type	Method and Description
UpdateIntegrationRequest	addRequestParametersEntry(String key, String value)
UpdateIntegrationRequest	addRequestTemplatesEntry(String key, String value)
UpdateIntegrationRequest	clearRequestParametersEntries() Removes all the entries added into RequestParameters.
UpdateIntegrationRequest	clearRequestTemplatesEntries() Removes all the entries added into RequestTemplates.
UpdateIntegrationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApiId() The API identifier.
String	getConnectionId() The connection ID.
String	getConnectionType() The type of the network connection to the integration endpoint.
String	getContentHandlingStrategy() Supported only for WebSocket APIs.
String	getCredentialsArn() Specifies the credentials required for the integration, if any.
String	getDescription() The description of the integration
String	getIntegrationId() The integration ID.
String	getIntegrationMethod() Specifies the integration's HTTP method type.
String	getIntegrationType() The integration type of an integration.
String	getIntegrationUri() For a Lambda proxy integration, this is the URI of the Lambda function.
String	getPassthroughBehavior() 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.
String	getPayloadFormatVersion() Specifies the format of the payload sent to an integration.
Map<String,String>	getRequestParameters() A key-value map specifying request parameters that are passed from the method request to the backend.
Map<String,String>	getRequestTemplates() 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.
String	getTemplateSelectionExpression() The template selection expression for the integration.
Integer	getTimeoutInMillis() Custom timeout between 50 and 29,000 milliseconds.
int	hashCode()
void	setApiId(String apiId) The API identifier.
void	setConnectionId(String connectionId) The connection ID.
void	setConnectionType(String connectionType) The type of the network connection to the integration endpoint.
void	setContentHandlingStrategy(String contentHandlingStrategy) Supported only for WebSocket APIs.
void	setCredentialsArn(String credentialsArn) Specifies the credentials required for the integration, if any.
void	setDescription(String description) The description of the integration
void	setIntegrationId(String integrationId) The integration ID.
void	setIntegrationMethod(String integrationMethod) Specifies the integration's HTTP method type.
void	setIntegrationType(String integrationType) The integration type of an integration.
void	setIntegrationUri(String integrationUri) For a Lambda proxy integration, this is the URI of the Lambda function.
void	setPassthroughBehavior(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.
void	setPayloadFormatVersion(String payloadFormatVersion) Specifies the format of the payload sent to an integration.
void	setRequestParameters(Map<String,String> requestParameters) A key-value map specifying request parameters that are passed from the method request to the backend.
void	setRequestTemplates(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.
void	setTemplateSelectionExpression(String templateSelectionExpression) The template selection expression for the integration.
void	setTimeoutInMillis(Integer timeoutInMillis) Custom timeout between 50 and 29,000 milliseconds.
String	toString() Returns a string representation of this object.
UpdateIntegrationRequest	withApiId(String apiId) The API identifier.
UpdateIntegrationRequest	withConnectionId(String connectionId) The connection ID.
UpdateIntegrationRequest	withConnectionType(ConnectionType connectionType) The type of the network connection to the integration endpoint.
UpdateIntegrationRequest	withConnectionType(String connectionType) The type of the network connection to the integration endpoint.
UpdateIntegrationRequest	withContentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy) Supported only for WebSocket APIs.
UpdateIntegrationRequest	withContentHandlingStrategy(String contentHandlingStrategy) Supported only for WebSocket APIs.
UpdateIntegrationRequest	withCredentialsArn(String credentialsArn) Specifies the credentials required for the integration, if any.
UpdateIntegrationRequest	withDescription(String description) The description of the integration
UpdateIntegrationRequest	withIntegrationId(String integrationId) The integration ID.
UpdateIntegrationRequest	withIntegrationMethod(String integrationMethod) Specifies the integration's HTTP method type.
UpdateIntegrationRequest	withIntegrationType(IntegrationType integrationType) The integration type of an integration.
UpdateIntegrationRequest	withIntegrationType(String integrationType) The integration type of an integration.
UpdateIntegrationRequest	withIntegrationUri(String integrationUri) For a Lambda proxy integration, this is the URI of the Lambda function.
UpdateIntegrationRequest	withPassthroughBehavior(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.
UpdateIntegrationRequest	withPassthroughBehavior(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.
UpdateIntegrationRequest	withPayloadFormatVersion(String payloadFormatVersion) Specifies the format of the payload sent to an integration.
UpdateIntegrationRequest	withRequestParameters(Map<String,String> requestParameters) A key-value map specifying request parameters that are passed from the method request to the backend.
UpdateIntegrationRequest	withRequestTemplates(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.
UpdateIntegrationRequest	withTemplateSelectionExpression(String templateSelectionExpression) The template selection expression for the integration.
UpdateIntegrationRequest	withTimeoutInMillis(Integer timeoutInMillis) Custom timeout between 50 and 29,000 milliseconds.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateIntegrationRequest

public UpdateIntegrationRequest()

Method Detail

setApiId

public void setApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

getApiId

public String getApiId()

The API identifier.

Returns:

The API identifier.

withApiId

public UpdateIntegrationRequest withApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

Returns:

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

setConnectionId

public void setConnectionId(String connectionId)

The connection ID.

Parameters:

connectionId - The connection ID.

getConnectionId

public String getConnectionId()

The connection ID.

Returns:

The connection ID.

withConnectionId

public UpdateIntegrationRequest withConnectionId(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.

setConnectionType

public void setConnectionType(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.

See Also:

ConnectionType

getConnectionType

public String getConnectionType()

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:

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

See Also:

ConnectionType

withConnectionType

public UpdateIntegrationRequest withConnectionType(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

withConnectionType

public UpdateIntegrationRequest withConnectionType(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

setContentHandlingStrategy

public void setContentHandlingStrategy(String 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.

Parameters:

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.

See Also:

ContentHandlingStrategy

getContentHandlingStrategy

public String getContentHandlingStrategy()

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.

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

withContentHandlingStrategy

public UpdateIntegrationRequest withContentHandlingStrategy(String 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.

Parameters:

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.

Returns:

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

See Also:

ContentHandlingStrategy

withContentHandlingStrategy

public UpdateIntegrationRequest withContentHandlingStrategy(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.

Parameters:

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.

Returns:

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

See Also:

ContentHandlingStrategy

setCredentialsArn

public void setCredentialsArn(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.

getCredentialsArn

public String getCredentialsArn()

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:

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.

withCredentialsArn

public UpdateIntegrationRequest withCredentialsArn(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.

setDescription

public void setDescription(String description)

The description of the integration

Parameters:

description - The description of the integration

getDescription

public String getDescription()

The description of the integration

Returns:

The description of the integration

withDescription

public UpdateIntegrationRequest withDescription(String description)

The description of the integration

Parameters:

description - The description of the integration

Returns:

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

setIntegrationId

public void setIntegrationId(String integrationId)

The integration ID.

Parameters:

integrationId - The integration ID.

getIntegrationId

public String getIntegrationId()

The integration ID.

Returns:

The integration ID.

withIntegrationId

public UpdateIntegrationRequest withIntegrationId(String integrationId)

The integration ID.

Parameters:

integrationId - The integration ID.

Returns:

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

setIntegrationMethod

public void setIntegrationMethod(String integrationMethod)

Specifies the integration's HTTP method type.

Parameters:

integrationMethod - Specifies the integration's HTTP method type.

getIntegrationMethod

public String getIntegrationMethod()

Specifies the integration's HTTP method type.

Returns:

Specifies the integration's HTTP method type.

withIntegrationMethod

public UpdateIntegrationRequest withIntegrationMethod(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.

setIntegrationType

public void setIntegrationType(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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

See Also:

IntegrationType

getIntegrationType

public String getIntegrationType()

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

Returns:

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

See Also:

IntegrationType

withIntegrationType

public UpdateIntegrationRequest withIntegrationType(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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

Returns:

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

See Also:

IntegrationType

withIntegrationType

public UpdateIntegrationRequest withIntegrationType(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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

Returns:

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

See Also:

IntegrationType

setIntegrationUri

public void setIntegrationUri(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.

getIntegrationUri

public String getIntegrationUri()

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

Returns:

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

withIntegrationUri

public UpdateIntegrationRequest withIntegrationUri(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.

setPassthroughBehavior

public void setPassthroughBehavior(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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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.

See Also:

PassthroughBehavior

getPassthroughBehavior

public String getPassthroughBehavior()

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. Supported only for WebSocket APIs.

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:

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. Supported only for WebSocket APIs.

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.

See Also:

PassthroughBehavior

withPassthroughBehavior

public UpdateIntegrationRequest withPassthroughBehavior(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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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

withPassthroughBehavior

public UpdateIntegrationRequest withPassthroughBehavior(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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

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

setPayloadFormatVersion

public void setPayloadFormatVersion(String payloadFormatVersion)

Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.

Parameters:

payloadFormatVersion - Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.

getPayloadFormatVersion

public String getPayloadFormatVersion()

Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.

Returns:

Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.

withPayloadFormatVersion

public UpdateIntegrationRequest withPayloadFormatVersion(String payloadFormatVersion)

Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.

Parameters:

payloadFormatVersion - Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.

Returns:

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

getRequestParameters

public Map<String,String> getRequestParameters()

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. Supported only for WebSocket APIs.

Returns:

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. Supported only for WebSocket APIs.

setRequestParameters

public void setRequestParameters(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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

withRequestParameters

public UpdateIntegrationRequest withRequestParameters(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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

Returns:

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

addRequestParametersEntry

public UpdateIntegrationRequest addRequestParametersEntry(String key,
                                                          String value)

clearRequestParametersEntries

public UpdateIntegrationRequest clearRequestParametersEntries()

Removes all the entries added into RequestParameters.

Returns:

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

getRequestTemplates

public Map<String,String> getRequestTemplates()

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. Supported only for WebSocket APIs.

Returns:

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. Supported only for WebSocket APIs.

setRequestTemplates

public void setRequestTemplates(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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

withRequestTemplates

public UpdateIntegrationRequest withRequestTemplates(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. Supported only for WebSocket APIs.

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. Supported only for WebSocket APIs.

Returns:

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

addRequestTemplatesEntry

public UpdateIntegrationRequest addRequestTemplatesEntry(String key,
                                                         String value)

clearRequestTemplatesEntries

public UpdateIntegrationRequest clearRequestTemplatesEntries()

Removes all the entries added into RequestTemplates.

Returns:

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

setTemplateSelectionExpression

public void setTemplateSelectionExpression(String templateSelectionExpression)

The template selection expression for the integration.

Parameters:

templateSelectionExpression - The template selection expression for the integration.

getTemplateSelectionExpression

public String getTemplateSelectionExpression()

The template selection expression for the integration.

Returns:

The template selection expression for the integration.

withTemplateSelectionExpression

public UpdateIntegrationRequest withTemplateSelectionExpression(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.

setTimeoutInMillis

public void setTimeoutInMillis(Integer timeoutInMillis)

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.

Parameters:

timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.

getTimeoutInMillis

public Integer getTimeoutInMillis()

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.

Returns:

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.

withTimeoutInMillis

public UpdateIntegrationRequest withTimeoutInMillis(Integer timeoutInMillis)

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.

Parameters:

timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.

Returns:

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

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateIntegrationRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()