@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PutIntegrationRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Sets up a method's integration.
NOOP
Constructor and Description |
---|
PutIntegrationRequest() |
Modifier and Type | Method and Description |
---|---|
PutIntegrationRequest |
addRequestParametersEntry(String key,
String value) |
PutIntegrationRequest |
addRequestTemplatesEntry(String key,
String value) |
PutIntegrationRequest |
clearRequestParametersEntries()
Removes all the entries added into RequestParameters.
|
PutIntegrationRequest |
clearRequestTemplatesEntries()
Removes all the entries added into RequestTemplates.
|
PutIntegrationRequest |
clone() |
boolean |
equals(Object obj) |
List<String> |
getCacheKeyParameters()
Specifies a put integration input's cache key parameters.
|
String |
getCacheNamespace()
Specifies a put integration input's cache namespace.
|
String |
getConnectionId()
|
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()
[Required] Specifies a put integration request's HTTP method.
|
String |
getIntegrationHttpMethod()
Specifies a put integration HTTP method.
|
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()
[Required] Specifies a put integration request's resource ID.
|
String |
getRestApiId()
[Required] The string identifier of the associated RestApi.
|
Integer |
getTimeoutInMillis()
Custom timeout between 50 and 29,000 milliseconds.
|
String |
getType()
[Required] 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)
Specifies a put integration input's cache key parameters.
|
void |
setCacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
|
void |
setConnectionId(String connectionId)
|
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)
[Required] Specifies a put integration request's HTTP method.
|
void |
setIntegrationHttpMethod(String integrationHttpMethod)
Specifies a put integration HTTP method.
|
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)
[Required] Specifies a put integration request's resource ID.
|
void |
setRestApiId(String restApiId)
[Required] The string identifier of the associated RestApi.
|
void |
setTimeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds.
|
void |
setType(IntegrationType type)
[Required] Specifies a put integration input's type.
|
void |
setType(String type)
[Required] 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)
Specifies a put integration input's cache key parameters.
|
PutIntegrationRequest |
withCacheKeyParameters(String... cacheKeyParameters)
Specifies a put integration input's cache key parameters.
|
PutIntegrationRequest |
withCacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
|
PutIntegrationRequest |
withConnectionId(String connectionId)
|
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)
[Required] Specifies a put integration request's HTTP method.
|
PutIntegrationRequest |
withIntegrationHttpMethod(String integrationHttpMethod)
Specifies a put integration HTTP method.
|
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)
[Required] Specifies a put integration request's resource ID.
|
PutIntegrationRequest |
withRestApiId(String restApiId)
[Required] The string identifier of the associated RestApi.
|
PutIntegrationRequest |
withTimeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds.
|
PutIntegrationRequest |
withType(IntegrationType type)
[Required] Specifies a put integration input's type.
|
PutIntegrationRequest |
withType(String type)
[Required] Specifies a put integration input's type.
|
PutIntegrationRequest |
withUri(String uri)
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
|
addHandlerContext, copyBaseTo, 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
public void setRestApiId(String restApiId)
[Required] The string identifier of the associated RestApi.
restApiId
- [Required] The string identifier of the associated RestApi.public String getRestApiId()
[Required] The string identifier of the associated RestApi.
public PutIntegrationRequest withRestApiId(String restApiId)
[Required] The string identifier of the associated RestApi.
restApiId
- [Required] The string identifier of the associated RestApi.public void setResourceId(String resourceId)
[Required] Specifies a put integration request's resource ID.
resourceId
- [Required] Specifies a put integration request's resource ID.public String getResourceId()
[Required] Specifies a put integration request's resource ID.
public PutIntegrationRequest withResourceId(String resourceId)
[Required] Specifies a put integration request's resource ID.
resourceId
- [Required] Specifies a put integration request's resource ID.public void setHttpMethod(String httpMethod)
[Required] Specifies a put integration request's HTTP method.
httpMethod
- [Required] Specifies a put integration request's HTTP method.public String getHttpMethod()
[Required] Specifies a put integration request's HTTP method.
public PutIntegrationRequest withHttpMethod(String httpMethod)
[Required] Specifies a put integration request's HTTP method.
httpMethod
- [Required] Specifies a put integration request's HTTP method.public void setType(String type)
[Required] Specifies a put integration input's type.
type
- [Required] Specifies a put integration input's type.IntegrationType
public String getType()
[Required] Specifies a put integration input's type.
IntegrationType
public PutIntegrationRequest withType(String type)
[Required] Specifies a put integration input's type.
type
- [Required] Specifies a put integration input's type.IntegrationType
public void setType(IntegrationType type)
[Required] Specifies a put integration input's type.
type
- [Required] Specifies a put integration input's type.IntegrationType
public PutIntegrationRequest withType(IntegrationType type)
[Required] Specifies a put integration input's type.
type
- [Required] Specifies a put integration input's type.IntegrationType
public void setIntegrationHttpMethod(String integrationHttpMethod)
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
integrationHttpMethod
- Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.public String getIntegrationHttpMethod()
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
public PutIntegrationRequest withIntegrationHttpMethod(String integrationHttpMethod)
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
integrationHttpMethod
- Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.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 AWS service (e.g., s3
); and {subdomain}
is a designated
subdomain supported by certain AWS service for fast host-name lookup. action
can be used for an AWS
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 AWS service path-based API. The ensuing
service_api
refers to the path to an AWS service resource, including the region of the integrated
AWS 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}
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 AWS service (e.g., s3
); and {subdomain}
is a
designated subdomain supported by certain AWS service for fast host-name lookup. action
can
be used for an AWS 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 AWS service path-based API. The ensuing
service_api
refers to the path to an AWS service resource, including the region of the
integrated AWS 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}
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 AWS service (e.g., s3
); and {subdomain}
is a designated
subdomain supported by certain AWS service for fast host-name lookup. action
can be used for an AWS
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 AWS service path-based API. The ensuing
service_api
refers to the path to an AWS service resource, including the region of the integrated
AWS 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}
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 AWS service (e.g., s3
); and {subdomain}
is a
designated subdomain supported by certain AWS service for fast host-name lookup. action
can
be used for an AWS 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 AWS service path-based API. The ensuing
service_api
refers to the path to an AWS service resource, including the region of the
integrated AWS 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}
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 AWS service (e.g., s3
); and {subdomain}
is a designated
subdomain supported by certain AWS service for fast host-name lookup. action
can be used for an AWS
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 AWS service path-based API. The ensuing
service_api
refers to the path to an AWS service resource, including the region of the integrated
AWS 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}
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 AWS service (e.g., s3
); and {subdomain}
is a
designated subdomain supported by certain AWS service for fast host-name lookup. action
can
be used for an AWS 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 AWS service path-based API. The ensuing
service_api
refers to the path to an AWS service resource, including the region of the
integrated AWS 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}
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
.
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
.ConnectionType
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
.
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
.ConnectionType
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
.
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
.ConnectionType
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
.
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
.ConnectionType
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
.
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
.ConnectionType
public void setConnectionId(String connectionId)
public String getConnectionId()
public PutIntegrationRequest withConnectionId(String connectionId)
public void setCredentials(String credentials)
Specifies whether credentials are required for a put integration.
credentials
- Specifies whether credentials are required for a put integration.public String getCredentials()
Specifies whether credentials are required for a put integration.
public PutIntegrationRequest withCredentials(String credentials)
Specifies whether credentials are required for a put integration.
credentials
- Specifies whether credentials are required for a put integration.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.
method.request.{location}.{name}
, where location
is querystring
,
path
, or header
and name
must be a valid and unique method request
parameter name.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.
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.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.
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.public PutIntegrationRequest addRequestParametersEntry(String key, String value)
public PutIntegrationRequest clearRequestParametersEntries()
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.
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.
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.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.
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.public PutIntegrationRequest addRequestTemplatesEntry(String key, String value)
public PutIntegrationRequest clearRequestTemplatesEntries()
public void setPassthroughBehavior(String passthroughBehavior)
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and
the available mapping templates specified as the requestTemplates
property on the Integration
resource. There are three valid values: WHEN_NO_MATCH
, WHEN_NO_TEMPLATES
, and
NEVER
.
WHEN_NO_MATCH
passes the request body for unmapped content types through to the integration back end
without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows pass-through when the integration has NO content types mapped to templates.
However if there is at least one content type defined, unmapped content types will be rejected with the same 415
response.
passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request,
and the available mapping templates specified as the requestTemplates
property on the
Integration resource. There are three valid values: WHEN_NO_MATCH
,
WHEN_NO_TEMPLATES
, and NEVER
.
WHEN_NO_MATCH
passes the request body for unmapped content types through to the integration
back end without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows pass-through when the integration has NO content types mapped to
templates. However if there is at least one content type defined, unmapped content types will be rejected
with the same 415 response.
public String getPassthroughBehavior()
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and
the available mapping templates specified as the requestTemplates
property on the Integration
resource. There are three valid values: WHEN_NO_MATCH
, WHEN_NO_TEMPLATES
, and
NEVER
.
WHEN_NO_MATCH
passes the request body for unmapped content types through to the integration back end
without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows pass-through when the integration has NO content types mapped to templates.
However if there is at least one content type defined, unmapped content types will be rejected with the same 415
response.
requestTemplates
property on
the Integration resource. There are three valid values: WHEN_NO_MATCH
,
WHEN_NO_TEMPLATES
, and NEVER
.
WHEN_NO_MATCH
passes the request body for unmapped content types through to the integration
back end without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows pass-through when the integration has NO content types mapped to
templates. However if there is at least one content type defined, unmapped content types will be rejected
with the same 415 response.
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
.
WHEN_NO_MATCH
passes the request body for unmapped content types through to the integration back end
without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows pass-through when the integration has NO content types mapped to templates.
However if there is at least one content type defined, unmapped content types will be rejected with the same 415
response.
passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request,
and the available mapping templates specified as the requestTemplates
property on the
Integration resource. There are three valid values: WHEN_NO_MATCH
,
WHEN_NO_TEMPLATES
, and NEVER
.
WHEN_NO_MATCH
passes the request body for unmapped content types through to the integration
back end without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows pass-through when the integration has NO content types mapped to
templates. However if there is at least one content type defined, unmapped content types will be rejected
with the same 415 response.
public void setCacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
cacheNamespace
- Specifies a put integration input's cache namespace.public String getCacheNamespace()
Specifies a put integration input's cache namespace.
public PutIntegrationRequest withCacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
cacheNamespace
- Specifies a put integration input's cache namespace.public List<String> getCacheKeyParameters()
Specifies a put integration input's cache key parameters.
public void setCacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
cacheKeyParameters
- Specifies a put integration input's cache key parameters.public PutIntegrationRequest withCacheKeyParameters(String... cacheKeyParameters)
Specifies a put integration input'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.
cacheKeyParameters
- Specifies a put integration input's cache key parameters.public PutIntegrationRequest withCacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
cacheKeyParameters
- Specifies a put integration input's cache key parameters.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.
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.
ContentHandlingStrategy
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.
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.
ContentHandlingStrategy
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:
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.
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.
ContentHandlingStrategy
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.
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.
ContentHandlingStrategy
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:
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.
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.
ContentHandlingStrategy
public void setTimeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.public Integer getTimeoutInMillis()
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
public PutIntegrationRequest withTimeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.public String toString()
toString
in class Object
Object.toString()
public PutIntegrationRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2019. All rights reserved.