@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock
integration.
| Constructor and Description |
|---|
UpdateIntegrationResult() |
| Modifier and Type | Method and Description |
|---|---|
UpdateIntegrationResult |
addIntegrationResponsesEntry(String key,
IntegrationResponse value)
Add a single IntegrationResponses entry
|
UpdateIntegrationResult |
addRequestParametersEntry(String key,
String value)
Add a single RequestParameters entry
|
UpdateIntegrationResult |
addRequestTemplatesEntry(String key,
String value)
Add a single RequestTemplates entry
|
UpdateIntegrationResult |
clearIntegrationResponsesEntries()
Removes all the entries added into IntegrationResponses.
|
UpdateIntegrationResult |
clearRequestParametersEntries()
Removes all the entries added into RequestParameters.
|
UpdateIntegrationResult |
clearRequestTemplatesEntries()
Removes all the entries added into RequestTemplates.
|
UpdateIntegrationResult |
clone() |
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 when
connectionType=VPC_LINK and undefined,
otherwise. |
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 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()
Specifies how the method request body of an unmapped content type will be passed through the integration request
to the back end without transformation.
|
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.
|
Integer |
getTimeoutInMillis()
Custom timeout between 50 and 29,000 milliseconds.
|
TlsConfig |
getTlsConfig()
Specifies the TLS configuration for an integration.
|
String |
getType()
Specifies an API method integration 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 when
connectionType=VPC_LINK and undefined,
otherwise. |
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 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)
Specifies how the method request body of an unmapped content type will be passed through the integration request
to the back end without transformation.
|
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 |
setTimeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds.
|
void |
setTlsConfig(TlsConfig tlsConfig)
Specifies the TLS configuration for an integration.
|
void |
setType(IntegrationType type)
Specifies an API method integration type.
|
void |
setType(String type)
Specifies an API method integration type.
|
void |
setUri(String uri)
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
|
String |
toString()
Returns a string representation of this object.
|
UpdateIntegrationResult |
withCacheKeyParameters(Collection<String> cacheKeyParameters)
A list of request parameters whose values API Gateway caches.
|
UpdateIntegrationResult |
withCacheKeyParameters(String... cacheKeyParameters)
A list of request parameters whose values API Gateway caches.
|
UpdateIntegrationResult |
withCacheNamespace(String cacheNamespace)
Specifies a group of related cached parameters.
|
UpdateIntegrationResult |
withConnectionId(String connectionId)
The ID of the VpcLink used for the integration when
connectionType=VPC_LINK and undefined,
otherwise. |
UpdateIntegrationResult |
withConnectionType(ConnectionType connectionType)
The type of the network connection to the integration endpoint.
|
UpdateIntegrationResult |
withConnectionType(String connectionType)
The type of the network connection to the integration endpoint.
|
UpdateIntegrationResult |
withContentHandling(ContentHandlingStrategy contentHandling)
Specifies how to handle request payload content type conversions.
|
UpdateIntegrationResult |
withContentHandling(String contentHandling)
Specifies how to handle request payload content type conversions.
|
UpdateIntegrationResult |
withCredentials(String credentials)
Specifies the credentials required for the integration, if any.
|
UpdateIntegrationResult |
withHttpMethod(String httpMethod)
Specifies the integration's HTTP method type.
|
UpdateIntegrationResult |
withIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)
Specifies the integration's responses.
|
UpdateIntegrationResult |
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.
|
UpdateIntegrationResult |
withRequestParameters(Map<String,String> requestParameters)
A key-value map specifying request parameters that are passed from the method request to the back end.
|
UpdateIntegrationResult |
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.
|
UpdateIntegrationResult |
withTimeoutInMillis(Integer timeoutInMillis)
Custom timeout between 50 and 29,000 milliseconds.
|
UpdateIntegrationResult |
withTlsConfig(TlsConfig tlsConfig)
Specifies the TLS configuration for an integration.
|
UpdateIntegrationResult |
withType(IntegrationType type)
Specifies an API method integration type.
|
UpdateIntegrationResult |
withType(String type)
Specifies an API method integration type.
|
UpdateIntegrationResult |
withUri(String uri)
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadatapublic void setType(String type)
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port
and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy
integration with a connectionType of VPC_LINK is referred to as a private integration
and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
type - Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or
HTTP proxy integration with a connectionType of VPC_LINK is referred to as a
private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
IntegrationTypepublic String getType()
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port
and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy
integration with a connectionType of VPC_LINK is referred to as a private integration
and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (
http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports
above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load
balancer of a VPC.
IntegrationTypepublic UpdateIntegrationResult withType(String type)
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port
and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy
integration with a connectionType of VPC_LINK is referred to as a private integration
and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
type - Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or
HTTP proxy integration with a connectionType of VPC_LINK is referred to as a
private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
IntegrationTypepublic void setType(IntegrationType type)
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port
and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy
integration with a connectionType of VPC_LINK is referred to as a private integration
and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
type - Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or
HTTP proxy integration with a connectionType of VPC_LINK is referred to as a
private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
IntegrationTypepublic UpdateIntegrationResult withType(IntegrationType type)
Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port
and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy
integration with a connectionType of VPC_LINK is referred to as a private integration
and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
type - Specifies an API method integration type. The valid value is one of the following:
For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https
), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or
HTTP proxy integration with a connectionType of VPC_LINK is referred to as a
private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
IntegrationTypepublic void setHttpMethod(String httpMethod)
Specifies the integration's HTTP method type. For the Type property, if you specify MOCK, this
property is optional. For Lambda integrations, you must set the integration method to POST. For all
other types, you must specify this property.
httpMethod - Specifies the integration's HTTP method type. For the Type property, if you specify MOCK,
this property is optional. For Lambda integrations, you must set the integration method to
POST. For all other types, you must specify this property.public String getHttpMethod()
Specifies the integration's HTTP method type. For the Type property, if you specify MOCK, this
property is optional. For Lambda integrations, you must set the integration method to POST. For all
other types, you must specify this property.
MOCK,
this property is optional. For Lambda integrations, you must set the integration method to
POST. For all other types, you must specify this property.public UpdateIntegrationResult withHttpMethod(String httpMethod)
Specifies the integration's HTTP method type. For the Type property, if you specify MOCK, this
property is optional. For Lambda integrations, you must set the integration method to POST. For all
other types, you must specify this property.
httpMethod - Specifies the integration's HTTP method type. For the Type property, if you specify MOCK,
this property is optional. For Lambda integrations, you must set the integration method to
POST. For all other types, you must specify this property.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 standard integrations. If connectionType is
VPC_LINK specify the Network Load Balancer DNS name. 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}
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 standard integrations. If
connectionType is VPC_LINK specify the Network Load Balancer DNS name. 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}
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 standard integrations. If connectionType is
VPC_LINK specify the Network Load Balancer DNS name. 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}
For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded
HTTP(S) URL according to the RFC-3986 specification for standard integrations. If
connectionType is VPC_LINK specify the Network Load Balancer DNS name. 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}
public UpdateIntegrationResult 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 standard integrations. If connectionType is
VPC_LINK specify the Network Load Balancer DNS name. 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}
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 standard integrations. If
connectionType is VPC_LINK specify the Network Load Balancer DNS name. 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}
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.ConnectionTypepublic 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.ConnectionTypepublic UpdateIntegrationResult 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.ConnectionTypepublic 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.ConnectionTypepublic UpdateIntegrationResult 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.ConnectionTypepublic void setConnectionId(String connectionId)
The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
otherwise.
connectionId - The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
otherwise.public String getConnectionId()
The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
otherwise.
connectionType=VPC_LINK and undefined,
otherwise.public UpdateIntegrationResult withConnectionId(String connectionId)
The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
otherwise.
connectionId - The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined,
otherwise.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 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 Amazon Web Services
services, specify null.
credentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are
available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To
require that the caller's identity be passed through from the request, specify the string
arn:aws:iam::\*:user/\*. To use resource-based permissions on supported Amazon Web Services
services, specify null.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 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 Amazon Web Services
services, specify null.
arn:aws:iam::\*:user/\*. To use resource-based permissions on supported Amazon Web Services
services, specify null.public UpdateIntegrationResult 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 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 Amazon Web Services
services, specify null.
credentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are
available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To
require that the caller's identity be passed through from the request, specify the string
arn:aws:iam::\*:user/\*. To use resource-based permissions on supported Amazon Web Services
services, specify null.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 UpdateIntegrationResult 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 UpdateIntegrationResult addRequestParametersEntry(String key, String value)
public UpdateIntegrationResult 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 UpdateIntegrationResult 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 UpdateIntegrationResult addRequestTemplatesEntry(String key, String value)
public UpdateIntegrationResult clearRequestTemplatesEntries()
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. The valid value is one of the following: 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.
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. The valid value is one of the following:
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.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. The valid value is one of the following: 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.
requestTemplates. The valid value is one of the following:
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.public UpdateIntegrationResult 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. The valid value is one of the following: 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.
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. The valid value is one of the following:
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.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.
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.
ContentHandlingStrategypublic 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.
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.
ContentHandlingStrategypublic UpdateIntegrationResult 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.
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.
ContentHandlingStrategypublic 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.
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.
ContentHandlingStrategypublic UpdateIntegrationResult 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.
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.
ContentHandlingStrategypublic 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 UpdateIntegrationResult 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 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.
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.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.
cacheNamespace. You can specify the same cacheNamespace across resources to
return the same cached data for requests to different resources.public UpdateIntegrationResult 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.
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.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.
cacheKeyParameters, these parameters must also be specified for Method
requestParameters.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.
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.public UpdateIntegrationResult 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.
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.public UpdateIntegrationResult 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.
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.public Map<String,IntegrationResponse> getIntegrationResponses()
Specifies the integration's responses.
public void setIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)
Specifies the integration's responses.
integrationResponses - Specifies the integration's responses.public UpdateIntegrationResult withIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)
Specifies the integration's responses.
integrationResponses - Specifies the integration's responses.public UpdateIntegrationResult addIntegrationResponsesEntry(String key, IntegrationResponse value)
public UpdateIntegrationResult clearIntegrationResponsesEntries()
public void setTlsConfig(TlsConfig tlsConfig)
Specifies the TLS configuration for an integration.
tlsConfig - Specifies the TLS configuration for an integration.public TlsConfig getTlsConfig()
Specifies the TLS configuration for an integration.
public UpdateIntegrationResult withTlsConfig(TlsConfig tlsConfig)
Specifies the TLS configuration for an integration.
tlsConfig - Specifies the TLS configuration for an integration.public String toString()
toString in class ObjectObject.toString()public UpdateIntegrationResult clone()