com.amazonaws.services.apigateway.model

Class PutIntegrationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.PutIntegrationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Sets up a method's integration.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutIntegrationRequest()

Method Summary

Modifier and Type	Method and Description
PutIntegrationRequest	addRequestParametersEntry(String key, String value) Add a single RequestParameters entry
PutIntegrationRequest	addRequestTemplatesEntry(String key, String value) Add a single RequestTemplates entry
PutIntegrationRequest	clearRequestParametersEntries() Removes all the entries added into RequestParameters.
PutIntegrationRequest	clearRequestTemplatesEntries() Removes all the entries added into RequestTemplates.
PutIntegrationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getCacheKeyParameters() A list of request parameters whose values API Gateway caches.
String	getCacheNamespace() Specifies a group of related cached parameters.
String	getConnectionId() The ID of the VpcLink used for the integration.
String	getConnectionType() The type of the network connection to the integration endpoint.
String	getContentHandling() Specifies how to handle request payload content type conversions.
String	getCredentials() Specifies whether credentials are required for a put integration.
String	getHttpMethod() Specifies the HTTP method for the integration.
String	getIntegrationHttpMethod() The HTTP method for the integration.
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 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	getResourceId() Specifies a put integration request's resource ID.
String	getRestApiId() The string identifier of the associated RestApi.
Integer	getTimeoutInMillis() Custom timeout between 50 and 29,000 milliseconds.
TlsConfig	getTlsConfig()
String	getType() Specifies a put integration input's type.
String	getUri() Specifies Uniform Resource Identifier (URI) of the integration endpoint.
int	hashCode()
void	setCacheKeyParameters(Collection<String> cacheKeyParameters) A list of request parameters whose values API Gateway caches.
void	setCacheNamespace(String cacheNamespace) Specifies a group of related cached parameters.
void	setConnectionId(String connectionId) The ID of the VpcLink used for the integration.
void	setConnectionType(ConnectionType connectionType) The type of the network connection to the integration endpoint.
void	setConnectionType(String connectionType) The type of the network connection to the integration endpoint.
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 whether credentials are required for a put integration.
void	setHttpMethod(String httpMethod) Specifies the HTTP method for the integration.
void	setIntegrationHttpMethod(String integrationHttpMethod) The HTTP method for the integration.
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 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	setResourceId(String resourceId) Specifies a put integration request's resource ID.
void	setRestApiId(String restApiId) The string identifier of the associated RestApi.
void	setTimeoutInMillis(Integer timeoutInMillis) Custom timeout between 50 and 29,000 milliseconds.
void	setTlsConfig(TlsConfig tlsConfig)
void	setType(IntegrationType type) Specifies a put integration input's type.
void	setType(String type) Specifies a put integration input's type.
void	setUri(String uri) Specifies Uniform Resource Identifier (URI) of the integration endpoint.
String	toString() Returns a string representation of this object.
PutIntegrationRequest	withCacheKeyParameters(Collection<String> cacheKeyParameters) A list of request parameters whose values API Gateway caches.
PutIntegrationRequest	withCacheKeyParameters(String... cacheKeyParameters) A list of request parameters whose values API Gateway caches.
PutIntegrationRequest	withCacheNamespace(String cacheNamespace) Specifies a group of related cached parameters.
PutIntegrationRequest	withConnectionId(String connectionId) The ID of the VpcLink used for the integration.
PutIntegrationRequest	withConnectionType(ConnectionType connectionType) The type of the network connection to the integration endpoint.
PutIntegrationRequest	withConnectionType(String connectionType) The type of the network connection to the integration endpoint.
PutIntegrationRequest	withContentHandling(ContentHandlingStrategy contentHandling) Specifies how to handle request payload content type conversions.
PutIntegrationRequest	withContentHandling(String contentHandling) Specifies how to handle request payload content type conversions.
PutIntegrationRequest	withCredentials(String credentials) Specifies whether credentials are required for a put integration.
PutIntegrationRequest	withHttpMethod(String httpMethod) Specifies the HTTP method for the integration.
PutIntegrationRequest	withIntegrationHttpMethod(String integrationHttpMethod) The HTTP method for the integration.
PutIntegrationRequest	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.
PutIntegrationRequest	withRequestParameters(Map<String,String> requestParameters) A key-value map specifying request parameters that are passed from the method request to the back end.
PutIntegrationRequest	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.
PutIntegrationRequest	withResourceId(String resourceId) Specifies a put integration request's resource ID.
PutIntegrationRequest	withRestApiId(String restApiId) The string identifier of the associated RestApi.
PutIntegrationRequest	withTimeoutInMillis(Integer timeoutInMillis) Custom timeout between 50 and 29,000 milliseconds.
PutIntegrationRequest	withTlsConfig(TlsConfig tlsConfig)
PutIntegrationRequest	withType(IntegrationType type) Specifies a put integration input's type.
PutIntegrationRequest	withType(String type) Specifies a put integration input's type.
PutIntegrationRequest	withUri(String uri) Specifies Uniform Resource Identifier (URI) of the integration endpoint.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutIntegrationRequest

public PutIntegrationRequest()

Method Detail

setRestApiId

public void setRestApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

getRestApiId

public String getRestApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

withRestApiId

public PutIntegrationRequest withRestApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

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

setResourceId

public void setResourceId(String resourceId)

Specifies a put integration request's resource ID.

Parameters:

resourceId - Specifies a put integration request's resource ID.

getResourceId

public String getResourceId()

Specifies a put integration request's resource ID.

Returns:

Specifies a put integration request's resource ID.

withResourceId

public PutIntegrationRequest withResourceId(String resourceId)

Specifies a put integration request's resource ID.

Parameters:

resourceId - Specifies a put integration request's resource ID.

Returns:

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

setHttpMethod

public void setHttpMethod(String httpMethod)

Specifies the HTTP method for the integration.

Parameters:

httpMethod - Specifies the HTTP method for the integration.

getHttpMethod

public String getHttpMethod()

Specifies the HTTP method for the integration.

Returns:

Specifies the HTTP method for the integration.

withHttpMethod

public PutIntegrationRequest withHttpMethod(String httpMethod)

Specifies the HTTP method for the integration.

Parameters:

httpMethod - Specifies the HTTP method for the integration.

Returns:

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

setType

public void setType(String type)

Specifies a put integration input's type.

Parameters:

type - Specifies a put integration input's type.

See Also:

IntegrationType

getType

public String getType()

Specifies a put integration input's type.

Returns:

Specifies a put integration input's type.

See Also:

IntegrationType

withType

public PutIntegrationRequest withType(String type)

Specifies a put integration input's type.

Parameters:

type - Specifies a put integration input's 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 a put integration input's type.

Parameters:

type - Specifies a put integration input's type.

See Also:

IntegrationType

withType

public PutIntegrationRequest withType(IntegrationType type)

Specifies a put integration input's type.

Parameters:

type - Specifies a put integration input's type.

Returns:

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

See Also:

IntegrationType

setIntegrationHttpMethod

public void setIntegrationHttpMethod(String integrationHttpMethod)

The HTTP method for the integration.

Parameters:

integrationHttpMethod - The HTTP method for the integration.

getIntegrationHttpMethod

public String getIntegrationHttpMethod()

The HTTP method for the integration.

Returns:

The HTTP method for the integration.

withIntegrationHttpMethod

public PutIntegrationRequest withIntegrationHttpMethod(String integrationHttpMethod)

The HTTP method for the integration.

Parameters:

integrationHttpMethod - The HTTP method for the integration.

Returns:

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

setUri

public void setUri(String uri)

Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

Parameters:

uri - Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

getUri

public String getUri()

Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

Returns:

Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK . For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

withUri

public PutIntegrationRequest withUri(String uri)

Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

Parameters:

uri - Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

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. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Parameters:

connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

See Also:

ConnectionType

getConnectionType

public String getConnectionType()

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Returns:

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

See Also:

ConnectionType

withConnectionType

public PutIntegrationRequest withConnectionType(String connectionType)

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Parameters:

connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Returns:

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

See Also:

ConnectionType

setConnectionType

public void setConnectionType(ConnectionType connectionType)

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Parameters:

connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

See Also:

ConnectionType

withConnectionType

public PutIntegrationRequest withConnectionType(ConnectionType connectionType)

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Parameters:

connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Returns:

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

See Also:

ConnectionType

setConnectionId

public void setConnectionId(String connectionId)

The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.

Parameters:

connectionId - The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.

getConnectionId

public String getConnectionId()

The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.

Returns:

The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.

withConnectionId

public PutIntegrationRequest withConnectionId(String connectionId)

The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.

Parameters:

connectionId - The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.

Returns:

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

setCredentials

public void setCredentials(String credentials)

Specifies whether credentials are required for a put integration.

Parameters:

credentials - Specifies whether credentials are required for a put integration.

getCredentials

public String getCredentials()

Specifies whether credentials are required for a put integration.

Returns:

Specifies whether credentials are required for a put integration.

withCredentials

public PutIntegrationRequest withCredentials(String credentials)

Specifies whether credentials are required for a put integration.

Parameters:

credentials - Specifies whether credentials are required for a put integration.

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 PutIntegrationRequest 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 PutIntegrationRequest addRequestParametersEntry(String key,
                                                       String value)

Add a single RequestParameters entry

See Also:

withRequestParameters(java.util.Map<java.lang.String, java.lang.String>)

clearRequestParametersEntries

public PutIntegrationRequest 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 PutIntegrationRequest 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 PutIntegrationRequest addRequestTemplatesEntry(String key,
                                                      String value)

Add a single RequestTemplates entry

See Also:

withRequestTemplates(java.util.Map<java.lang.String, java.lang.String>)

clearRequestTemplatesEntries

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

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.

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.

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.

withPassthroughBehavior

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

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.

Returns:

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

setCacheNamespace

public void setCacheNamespace(String cacheNamespace)

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Parameters:

cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

getCacheNamespace

public String getCacheNamespace()

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Returns:

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

withCacheNamespace

public PutIntegrationRequest withCacheNamespace(String cacheNamespace)

Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Parameters:

cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

Returns:

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

getCacheKeyParameters

public List<String> getCacheKeyParameters()

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Returns:

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

setCacheKeyParameters

public void setCacheKeyParameters(Collection<String> cacheKeyParameters)

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Parameters:

cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

withCacheKeyParameters

public PutIntegrationRequest withCacheKeyParameters(String... cacheKeyParameters)

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

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 - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Returns:

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

withCacheKeyParameters

public PutIntegrationRequest withCacheKeyParameters(Collection<String> cacheKeyParameters)

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

Parameters:

cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

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:

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 passthroughBehavior 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:

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 passthroughBehavior 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:

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 passthroughBehavior 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:

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 passthroughBehavior is configured to support payload pass-through.

See Also:

ContentHandlingStrategy

withContentHandling

public PutIntegrationRequest 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:

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 passthroughBehavior 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:

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 passthroughBehavior 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:

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 passthroughBehavior 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:

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 passthroughBehavior is configured to support payload pass-through.

See Also:

ContentHandlingStrategy

withContentHandling

public PutIntegrationRequest 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:

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 passthroughBehavior 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:

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 passthroughBehavior 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

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

setTlsConfig

public void setTlsConfig(TlsConfig tlsConfig)

Parameters:

tlsConfig -

getTlsConfig

public TlsConfig getTlsConfig()

Returns:

withTlsConfig

public PutIntegrationRequest withTlsConfig(TlsConfig tlsConfig)

Parameters:

tlsConfig -

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

Description copied from class: AmazonWebServiceRequest

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

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()