Class PutIntegrationRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutIntegrationRequest.Builder,
PutIntegrationRequest>
Sets up a method's integration.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
A list of request parameters whose values API Gateway caches.final String
Specifies a group of related cached parameters.final String
The ID of the VpcLink used for the integration.final ConnectionType
The type of the network connection to the integration endpoint.final String
The type of the network connection to the integration endpoint.final ContentHandlingStrategy
Specifies how to handle request payload content type conversions.final String
Specifies how to handle request payload content type conversions.final String
Specifies whether credentials are required for a put integration.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the CacheKeyParameters property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RequestParameters property.final boolean
For responses, this returns true if the service returned a value for the RequestTemplates property.final String
Specifies the HTTP method for the integration.final String
The HTTP method for the integration.final String
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as therequestTemplates
property on the Integration resource.A key-value map specifying request parameters that are passed from the method request to the back end.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.final String
Specifies a put integration request's resource ID.final String
The string identifier of the associated RestApi.static Class
<? extends PutIntegrationRequest.Builder> final Integer
Custom timeout between 50 and 29,000 milliseconds.final TlsConfig
Returns the value of the TlsConfig property for this object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final IntegrationType
type()
Specifies a put integration input's type.final String
Specifies a put integration input's type.final String
uri()
Specifies Uniform Resource Identifier (URI) of the integration endpoint.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
restApiId
The string identifier of the associated RestApi.
- Returns:
- The string identifier of the associated RestApi.
-
resourceId
Specifies a put integration request's resource ID.
- Returns:
- Specifies a put integration request's resource ID.
-
httpMethod
Specifies the HTTP method for the integration.
- Returns:
- Specifies the HTTP method for the integration.
-
type
Specifies a put integration input's type.
If the service returns an enum value that is not available in the current SDK version,
type
will returnIntegrationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Specifies a put integration input's type.
- See Also:
-
typeAsString
Specifies a put integration input's type.
If the service returns an enum value that is not available in the current SDK version,
type
will returnIntegrationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Specifies a put integration input's type.
- See Also:
-
integrationHttpMethod
The HTTP method for the integration.
- Returns:
- The HTTP method for the integration.
-
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, whereconnectionType
is notVPC_LINK
, or private integration, whereconnectionType
isVPC_LINK
. For a private HTTP integration, the URI is not used for routing. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn: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 ofGetObject
, theuri
can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn: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, whereconnectionType
is notVPC_LINK
, or private integration, whereconnectionType
isVPC_LINK
. For a private HTTP integration, the URI is not used for routing. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn: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 ofGetObject
, theuri
can be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
.
-
connectionType
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.If the service returns an enum value that is not available in the current SDK version,
connectionType
will returnConnectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionTypeAsString()
.- Returns:
- The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
. - See Also:
-
connectionTypeAsString
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.If the service returns an enum value that is not available in the current SDK version,
connectionType
will returnConnectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectionTypeAsString()
.- Returns:
- The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
. - See Also:
-
connectionId
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.
-
credentials
Specifies whether credentials are required for a put integration.
- Returns:
- Specifies whether credentials are required for a put integration.
-
hasRequestParameters
public final boolean hasRequestParameters()For responses, this returns true if the service returned a value for the RequestParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRequestParameters()
method.- 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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.
-
hasRequestTemplates
public final boolean hasRequestTemplates()For responses, this returns true if the service returned a value for the RequestTemplates property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRequestTemplates()
method.- 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.
-
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
, andNEVER
.- 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
, andNEVER
.
-
cacheNamespace
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
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 samecacheNamespace
across resources to return the same cached data for requests to different resources.
-
hasCacheKeyParameters
public final boolean hasCacheKeyParameters()For responses, this returns true if the service returned a value for the CacheKeyParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
cacheKeyParameters
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasCacheKeyParameters()
method.- Returns:
- A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.
-
contentHandling
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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.If the service returns an enum value that is not available in the current SDK version,
contentHandling
will returnContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentHandlingAsString()
.- Returns:
- Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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:
-
contentHandlingAsString
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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.If the service returns an enum value that is not available in the current SDK version,
contentHandling
will returnContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontentHandlingAsString()
.- Returns:
- Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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:
-
timeoutInMillis
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.
-
tlsConfig
Returns the value of the TlsConfig property for this object.- Returns:
- The value of the TlsConfig property for this object.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutIntegrationRequest.Builder,
PutIntegrationRequest> - Specified by:
toBuilder
in classApiGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-