com.amazonaws.services.apigatewayv2.model

Class GetIntegrationResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.apigatewayv2.model.GetIntegrationResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetIntegrationResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetIntegrationResult()

Method Summary

Modifier and Type	Method and Description
GetIntegrationResult	addRequestParametersEntry(String key, String value)
GetIntegrationResult	addRequestTemplatesEntry(String key, String value)
GetIntegrationResult	clearRequestParametersEntries() Removes all the entries added into RequestParameters.
GetIntegrationResult	clearRequestTemplatesEntries() Removes all the entries added into RequestTemplates.
GetIntegrationResult	clone()
boolean	equals(Object obj)
String	getConnectionId() The connection ID.
String	getConnectionType() The type of the network connection to the integration endpoint.
String	getContentHandlingStrategy() Specifies how to handle response payload content type conversions.
String	getCredentialsArn() Specifies the credentials required for the integration, if any.
String	getDescription() Represents the description of an integration.
String	getIntegrationId() Represents the identifier of an integration.
String	getIntegrationMethod() Specifies the integration's HTTP method type.
String	getIntegrationResponseSelectionExpression() The integration response selection expression for the integration.
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.
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	setConnectionId(String connectionId) The connection ID.
void	setConnectionType(String connectionType) The type of the network connection to the integration endpoint.
void	setContentHandlingStrategy(String contentHandlingStrategy) Specifies how to handle response payload content type conversions.
void	setCredentialsArn(String credentialsArn) Specifies the credentials required for the integration, if any.
void	setDescription(String description) Represents the description of an integration.
void	setIntegrationId(String integrationId) Represents the identifier of an integration.
void	setIntegrationMethod(String integrationMethod) Specifies the integration's HTTP method type.
void	setIntegrationResponseSelectionExpression(String integrationResponseSelectionExpression) The integration response selection expression for the integration.
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	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.
GetIntegrationResult	withConnectionId(String connectionId) The connection ID.
GetIntegrationResult	withConnectionType(ConnectionType connectionType) The type of the network connection to the integration endpoint.
GetIntegrationResult	withConnectionType(String connectionType) The type of the network connection to the integration endpoint.
GetIntegrationResult	withContentHandlingStrategy(ContentHandlingStrategy contentHandlingStrategy) Specifies how to handle response payload content type conversions.
GetIntegrationResult	withContentHandlingStrategy(String contentHandlingStrategy) Specifies how to handle response payload content type conversions.
GetIntegrationResult	withCredentialsArn(String credentialsArn) Specifies the credentials required for the integration, if any.
GetIntegrationResult	withDescription(String description) Represents the description of an integration.
GetIntegrationResult	withIntegrationId(String integrationId) Represents the identifier of an integration.
GetIntegrationResult	withIntegrationMethod(String integrationMethod) Specifies the integration's HTTP method type.
GetIntegrationResult	withIntegrationResponseSelectionExpression(String integrationResponseSelectionExpression) The integration response selection expression for the integration.
GetIntegrationResult	withIntegrationType(IntegrationType integrationType) The integration type of an integration.
GetIntegrationResult	withIntegrationType(String integrationType) The integration type of an integration.
GetIntegrationResult	withIntegrationUri(String integrationUri) For a Lambda proxy integration, this is the URI of the Lambda function.
GetIntegrationResult	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.
GetIntegrationResult	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.
GetIntegrationResult	withRequestParameters(Map<String,String> requestParameters) A key-value map specifying request parameters that are passed from the method request to the backend.
GetIntegrationResult	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.
GetIntegrationResult	withTemplateSelectionExpression(String templateSelectionExpression) The template selection expression for the integration.
GetIntegrationResult	withTimeoutInMillis(Integer timeoutInMillis) Custom timeout between 50 and 29,000 milliseconds.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetIntegrationResult

public GetIntegrationResult()

Method Detail

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

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.

See Also:

ContentHandlingStrategy

getContentHandlingStrategy

public String getContentHandlingStrategy()

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:

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 GetIntegrationResult withContentHandlingStrategy(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

withContentHandlingStrategy

public GetIntegrationResult withContentHandlingStrategy(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

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

Represents the description of an integration.

Parameters:

description - Represents the description of an integration.

getDescription

public String getDescription()

Represents the description of an integration.

Returns:

Represents the description of an integration.

withDescription

public GetIntegrationResult withDescription(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.

setIntegrationId

public void setIntegrationId(String integrationId)

Represents the identifier of an integration.

Parameters:

integrationId - Represents the identifier of an integration.

getIntegrationId

public String getIntegrationId()

Represents the identifier of an integration.

Returns:

Represents the identifier of an integration.

withIntegrationId

public GetIntegrationResult withIntegrationId(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.

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 GetIntegrationResult 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.

setIntegrationResponseSelectionExpression

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

getIntegrationResponseSelectionExpression

public String getIntegrationResponseSelectionExpression()

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

Returns:

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

withIntegrationResponseSelectionExpression

public GetIntegrationResult withIntegrationResponseSelectionExpression(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.

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.

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.

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.

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:

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.

See Also:

IntegrationType

withIntegrationType

public GetIntegrationResult 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.

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

withIntegrationType

public GetIntegrationResult 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.

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

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 GetIntegrationResult 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.

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.

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.

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.

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 GetIntegrationResult 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.

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

withPassthroughBehavior

public GetIntegrationResult 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.

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

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.

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.

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.

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.

withRequestParameters

public GetIntegrationResult 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.

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.

addRequestParametersEntry

public GetIntegrationResult addRequestParametersEntry(String key,
                                                      String value)

clearRequestParametersEntries

public GetIntegrationResult 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.

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.

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.

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.

withRequestTemplates

public GetIntegrationResult 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.

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.

addRequestTemplatesEntry

public GetIntegrationResult addRequestTemplatesEntry(String key,
                                                     String value)

clearRequestTemplatesEntries

public GetIntegrationResult 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 GetIntegrationResult 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.

Parameters:

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

getTimeoutInMillis

public Integer getTimeoutInMillis()

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

Returns:

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

withTimeoutInMillis

public GetIntegrationResult withTimeoutInMillis(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.

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

Overrides:

clone in class Object