GetIntegrationResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.apigateway.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
```
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

In the API Gateway console, the built-in Lambda integration is an AWS integration.

Creating an API

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetIntegrationResult()

Constructors
Constructor and Description
`GetIntegrationResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetIntegrationResult`	`addIntegrationResponsesEntry(String key, IntegrationResponse value)`
`GetIntegrationResult`	`addRequestParametersEntry(String key, String value)`
`GetIntegrationResult`	`addRequestTemplatesEntry(String key, String value)`
`GetIntegrationResult`	`clearIntegrationResponsesEntries()` Removes all the entries added into IntegrationResponses.
`GetIntegrationResult`	`clearRequestParametersEntries()` Removes all the entries added into RequestParameters.
`GetIntegrationResult`	`clearRequestTemplatesEntries()` Removes all the entries added into RequestTemplates.
`GetIntegrationResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getCacheKeyParameters()` Specifies the integration's cache key parameters.
`String`	`getCacheNamespace()` Specifies the integration's cache namespace.
`String`	`getContentHandling()` Specifies how to handle request payload content type conversions.
`String`	`getCredentials()` Specifies the credentials required for the integration, if any.
`String`	`getHttpMethod()` Specifies the integration's HTTP method type.
`Map<String,IntegrationResponse>`	`getIntegrationResponses()` Specifies the integration's responses.
`String`	`getPassthroughBehavior()`
`Map<String,String>`	`getRequestParameters()` A key-value map specifying request parameters that are passed from the method request to the back end.
`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`	`getType()` Specifies the integration's type.
`String`	`getUri()` Specifies the integration's Uniform Resource Identifier (URI).
`int`	`hashCode()`
`void`	`setCacheKeyParameters(Collection<String> cacheKeyParameters)` Specifies the integration's cache key parameters.
`void`	`setCacheNamespace(String cacheNamespace)` Specifies the integration's cache namespace.
`void`	`setContentHandling(ContentHandlingStrategy contentHandling)` Specifies how to handle request payload content type conversions.
`void`	`setContentHandling(String contentHandling)` Specifies how to handle request payload content type conversions.
`void`	`setCredentials(String credentials)` Specifies the credentials required for the integration, if any.
`void`	`setHttpMethod(String httpMethod)` Specifies the integration's HTTP method type.
`void`	`setIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)` Specifies the integration's responses.
`void`	`setPassthroughBehavior(String passthroughBehavior)`
`void`	`setRequestParameters(Map<String,String> requestParameters)` A key-value map specifying request parameters that are passed from the method request to the back end.
`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`	`setType(IntegrationType type)` Specifies the integration's type.
`void`	`setType(String type)` Specifies the integration's type.
`void`	`setUri(String uri)` Specifies the integration's Uniform Resource Identifier (URI).
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GetIntegrationResult`	`withCacheKeyParameters(Collection<String> cacheKeyParameters)` Specifies the integration's cache key parameters.
`GetIntegrationResult`	`withCacheKeyParameters(String... cacheKeyParameters)` Specifies the integration's cache key parameters.
`GetIntegrationResult`	`withCacheNamespace(String cacheNamespace)` Specifies the integration's cache namespace.
`GetIntegrationResult`	`withContentHandling(ContentHandlingStrategy contentHandling)` Specifies how to handle request payload content type conversions.
`GetIntegrationResult`	`withContentHandling(String contentHandling)` Specifies how to handle request payload content type conversions.
`GetIntegrationResult`	`withCredentials(String credentials)` Specifies the credentials required for the integration, if any.
`GetIntegrationResult`	`withHttpMethod(String httpMethod)` Specifies the integration's HTTP method type.
`GetIntegrationResult`	`withIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)` Specifies the integration's responses.
`GetIntegrationResult`	`withPassthroughBehavior(String passthroughBehavior)`
`GetIntegrationResult`	`withRequestParameters(Map<String,String> requestParameters)` A key-value map specifying request parameters that are passed from the method request to the back end.
`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`	`withType(IntegrationType type)` Specifies the integration's type.
`GetIntegrationResult`	`withType(String type)` Specifies the integration's type.
`GetIntegrationResult`	`withUri(String uri)` Specifies the integration's Uniform Resource Identifier (URI).

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
  - setType
```
public void setType(String type)
```
    Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
    
    Parameters:
    
    type - Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
    
    See Also:
    
    IntegrationType
  - getType
```
public String getType()
```
    Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
    
    Returns:
    
    Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
    
    See Also:
    
    IntegrationType
  - withType
```
public GetIntegrationResult withType(String type)
```
    Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
    
    Parameters:
    
    type - Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IntegrationType
  - setType
```
public void setType(IntegrationType type)
```
    Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
    
    Parameters:
    
    type - Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
    
    See Also:
    
    IntegrationType
  - withType
```
public GetIntegrationResult withType(IntegrationType type)
```
    Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
    
    Parameters:
    
    type - Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IntegrationType
  - setHttpMethod
```
public void setHttpMethod(String httpMethod)
```
    Specifies the integration's HTTP method type.
    
    Parameters:
    
    httpMethod - Specifies the integration's HTTP method type.
  - getHttpMethod
```
public String getHttpMethod()
```
    Specifies the integration's HTTP method type.
    
    Returns:
    
    Specifies the integration's HTTP method type.
  - withHttpMethod
```
public GetIntegrationResult withHttpMethod(String httpMethod)
```
    Specifies the integration's HTTP method type.
    
    Parameters:
    
    httpMethod - Specifies the integration's HTTP method type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUri
```
public void setUri(String uri)
```
    Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.
    
    Parameters:
    
    uri - Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.
  - getUri
```
public String getUri()
```
    Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.
    
    Returns:
    
    Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.
  - withUri
```
public GetIntegrationResult withUri(String uri)
```
    Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.
    
    Parameters:
    
    uri - Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCredentials
```
public void setCredentials(String credentials)
```
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon 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:
    
    credentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon 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.
  - getCredentials
```
public String getCredentials()
```
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon 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 Amazon 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.
  - withCredentials
```
public GetIntegrationResult withCredentials(String credentials)
```
    Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon 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:
    
    credentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon 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.
  - getRequestParameters
```
public Map<String,String> getRequestParameters()
```
    A key-value map specifying request parameters that are passed from the method request to the back end. 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 back end. 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 back end. 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 back end. 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 back end. 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 back end. 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 back end. 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 back end. 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 back end. 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 back end. 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 back end. 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 back end. 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.
  - setPassthroughBehavior
```
public void setPassthroughBehavior(String passthroughBehavior)
```
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
    
    WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    Parameters:
    passthroughBehavior -
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
    
    WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
  - getPassthroughBehavior
```
public String getPassthroughBehavior()
```
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
    
    WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    Returns:
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
    
    WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
  - withPassthroughBehavior
```
public GetIntegrationResult withPassthroughBehavior(String passthroughBehavior)
```
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
    
    WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    Parameters:
    passthroughBehavior -
    Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
    
    WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
    
    WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
    
    NEVER rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContentHandling
```
public void setContentHandling(String contentHandling)
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
    Parameters:
    contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
    See Also:
    
    ContentHandlingStrategy
  - getContentHandling
```
public String getContentHandling()
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
    Returns:
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
    See Also:
    
    ContentHandlingStrategy
  - withContentHandling
```
public GetIntegrationResult withContentHandling(String contentHandling)
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
    Parameters:
    contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContentHandlingStrategy
  - setContentHandling
```
public void setContentHandling(ContentHandlingStrategy contentHandling)
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
    Parameters:
    contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
    See Also:
    
    ContentHandlingStrategy
  - withContentHandling
```
public GetIntegrationResult withContentHandling(ContentHandlingStrategy contentHandling)
```
    Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    - CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    - CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
    Parameters:
    contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
    
    CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
    
    CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
    
    If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContentHandlingStrategy
  - setCacheNamespace
```
public void setCacheNamespace(String cacheNamespace)
```
    Specifies the integration's cache namespace.
    
    Parameters:
    
    cacheNamespace - Specifies the integration's cache namespace.
  - getCacheNamespace
```
public String getCacheNamespace()
```
    Specifies the integration's cache namespace.
    
    Returns:
    
    Specifies the integration's cache namespace.
  - withCacheNamespace
```
public GetIntegrationResult withCacheNamespace(String cacheNamespace)
```
    Specifies the integration's cache namespace.
    
    Parameters:
    
    cacheNamespace - Specifies the integration's cache namespace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCacheKeyParameters
```
public List<String> getCacheKeyParameters()
```
    Specifies the integration's cache key parameters.
    
    Returns:
    
    Specifies the integration's cache key parameters.
  - setCacheKeyParameters
```
public void setCacheKeyParameters(Collection<String> cacheKeyParameters)
```
    Specifies the integration's cache key parameters.
    
    Parameters:
    
    cacheKeyParameters - Specifies the integration's cache key parameters.
  - withCacheKeyParameters
```
public GetIntegrationResult withCacheKeyParameters(String... cacheKeyParameters)
```
    Specifies the integration's cache key parameters.
    
    NOTE: This method appends the values to the existing list (if any). Use setCacheKeyParameters(java.util.Collection) or withCacheKeyParameters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    cacheKeyParameters - Specifies the integration's cache key parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCacheKeyParameters
```
public GetIntegrationResult withCacheKeyParameters(Collection<String> cacheKeyParameters)
```
    Specifies the integration's cache key parameters.
    
    Parameters:
    
    cacheKeyParameters - Specifies the integration's cache key parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIntegrationResponses
```
public Map<String,IntegrationResponse> getIntegrationResponses()
```
    Specifies the integration's responses.
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    Creating an API
    Returns:
    Specifies the integration's responses.
    
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    
    Creating an API
  - setIntegrationResponses
```
public void setIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)
```
    Specifies the integration's responses.
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    Creating an API
    Parameters:
    integrationResponses - Specifies the integration's responses.
    
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    
    Creating an API
  - withIntegrationResponses
```
public GetIntegrationResult withIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)
```
    Specifies the integration's responses.
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    Creating an API
    Parameters:
    integrationResponses - Specifies the integration's responses.
    
    Example: Get integration responses of a method
    
    Request
    
    GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
    
    Response
    
    The successful response returns 200 OK status and a payload as follows:
    
    { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
    
    Creating an API
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addIntegrationResponsesEntry
```
public GetIntegrationResult addIntegrationResponsesEntry(String key,
                                                         IntegrationResponse value)
```
  - clearIntegrationResponsesEntries
```
public GetIntegrationResult clearIntegrationResponsesEntries()
```
    Removes all the entries added into IntegrationResponses.
    
    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; useful for testing and debugging.
    
    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

Did this page help you?

Class GetIntegrationResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetIntegrationResult

Method Detail

setType

getType

withType

setType

withType

setHttpMethod

getHttpMethod

withHttpMethod

setUri

getUri

withUri

setCredentials

getCredentials

withCredentials

getRequestParameters

setRequestParameters

withRequestParameters

addRequestParametersEntry

clearRequestParametersEntries

getRequestTemplates

setRequestTemplates

withRequestTemplates

addRequestTemplatesEntry

clearRequestTemplatesEntries

setPassthroughBehavior

getPassthroughBehavior

withPassthroughBehavior

setContentHandling

getContentHandling

withContentHandling

setContentHandling

withContentHandling

setCacheNamespace

getCacheNamespace

withCacheNamespace

getCacheKeyParameters

setCacheKeyParameters

withCacheKeyParameters

withCacheKeyParameters

getIntegrationResponses

Example: Get integration responses of a method

Request

Response

Example: Get integration responses of a method

Request

Response

setIntegrationResponses

Example: Get integration responses of a method

Request

Response

Example: Get integration responses of a method

Request

Response

withIntegrationResponses

Example: Get integration responses of a method

Request

Response

Example: Get integration responses of a method

Request

Response

addIntegrationResponsesEntry

clearIntegrationResponsesEntries

toString

equals

hashCode

clone