Class PutIntegrationRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents a put integration request.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddRequestParametersEntry
(String key, String value) addRequestTemplatesEntry
(String key, String value) Removes all the entries added into RequestParameters.Removes all the entries added into RequestTemplates.clone()
Creates a shallow clone of this request.boolean
Specifies a put integration input's cache key parameters.Specifies a put integration input's cache namespace.Specifies whether credentials are required for a put integration.Specifies a put integration request's HTTP method.Specifies a put integration HTTP method.Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration.Represents request parameters that are sent with the backend request.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.Specifies a put integration request's resource ID.Specifies a put integration request's API identifier.getType()
Specifies a put integration input's type.getUri()
Specifies a put integration input's Uniform Resource Identifier (URI).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
setCredentials
(String credentials) Specifies whether credentials are required for a put integration.void
setHttpMethod
(String httpMethod) 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 requestTemplates defined on the Integration.void
setRequestParameters
(Map<String, String> requestParameters) Represents request parameters that are sent with the backend request.void
setRequestTemplates
(Map<String, String> requestTemplates) Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.void
setResourceId
(String resourceId) Specifies a put integration request's resource ID.void
setRestApiId
(String restApiId) Specifies a put integration request's API identifier.void
setType
(IntegrationType type) Specifies a put integration input's type.void
Specifies a put integration input's type.void
Specifies a put integration input's Uniform Resource Identifier (URI).toString()
Returns a string representation of this object; useful for testing and debugging.withCacheKeyParameters
(String... cacheKeyParameters) Specifies a put integration input's cache key parameters.withCacheKeyParameters
(Collection<String> cacheKeyParameters) Specifies a put integration input's cache key parameters.withCacheNamespace
(String cacheNamespace) Specifies a put integration input's cache namespace.withCredentials
(String credentials) Specifies whether credentials are required for a put integration.withHttpMethod
(String httpMethod) Specifies a put integration request's HTTP method.withIntegrationHttpMethod
(String integrationHttpMethod) Specifies a put integration HTTP method.withPassthroughBehavior
(String passthroughBehavior) Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration.withRequestParameters
(Map<String, String> requestParameters) Represents request parameters that are sent with the backend request.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.withResourceId
(String resourceId) Specifies a put integration request's resource ID.withRestApiId
(String restApiId) Specifies a put integration request's API identifier.withType
(IntegrationType type) Specifies a put integration input's type.Specifies a put integration input's type.Specifies a put integration input's Uniform Resource Identifier (URI).Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
PutIntegrationRequest
public PutIntegrationRequest()
-
-
Method Details
-
setRestApiId
Specifies a put integration request's API identifier.
- Parameters:
restApiId
- Specifies a put integration request's API identifier.
-
getRestApiId
Specifies a put integration request's API identifier.
- Returns:
- Specifies a put integration request's API identifier.
-
withRestApiId
Specifies a put integration request's API identifier.
- Parameters:
restApiId
- Specifies a put integration request's API identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setResourceId
Specifies a put integration request's resource ID.
- Parameters:
resourceId
- Specifies a put integration request's resource ID.
-
getResourceId
Specifies a put integration request's resource ID.
- Returns:
- Specifies a put integration request's resource ID.
-
withResourceId
Specifies a put integration request's resource ID.
- Parameters:
resourceId
- Specifies a put integration request's resource ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHttpMethod
Specifies a put integration request's HTTP method.
- Parameters:
httpMethod
- Specifies a put integration request's HTTP method.
-
getHttpMethod
Specifies a put integration request's HTTP method.
- Returns:
- Specifies a put integration request's HTTP method.
-
withHttpMethod
Specifies a put integration request's HTTP method.
- Parameters:
httpMethod
- Specifies a put integration request's HTTP method.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setType
Specifies a put integration input's type.
- Parameters:
type
- Specifies a put integration input's type.- See Also:
-
getType
Specifies a put integration input's type.
- Returns:
- Specifies a put integration input's type.
- See Also:
-
withType
Specifies a put integration input's type.
- Parameters:
type
- Specifies a put integration input's type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setType
Specifies a put integration input's type.
- Parameters:
type
- Specifies a put integration input's type.- See Also:
-
withType
Specifies a put integration input's type.
- Parameters:
type
- Specifies a put integration input's type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setIntegrationHttpMethod
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
- Parameters:
integrationHttpMethod
- Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
-
getIntegrationHttpMethod
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
- Returns:
- Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
-
withIntegrationHttpMethod
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
- Parameters:
integrationHttpMethod
- Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUri
Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.
- Parameters:
uri
- Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.
-
getUri
Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.
- Returns:
- Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.
-
withUri
Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.
- Parameters:
uri
- Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCredentials
Specifies whether credentials are required for a put integration.
- Parameters:
credentials
- Specifies whether credentials are required for a put integration.
-
getCredentials
Specifies whether credentials are required for a put integration.
- Returns:
- Specifies whether credentials are required for a put integration.
-
withCredentials
Specifies whether credentials are required for a put integration.
- Parameters:
credentials
- Specifies whether credentials are required for a put integration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getRequestParameters
Represents request parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern
integration.request.{location}.{name}
, wherelocation
is either querystring, path, or header.name
must be a valid, unique parameter name.- Returns:
- Represents request parameters that are sent with the backend
request. Request parameters are represented as a key/value map,
with a destination as the key and a source as the value. A source
must match an existing method request parameter, or a static
value. Static values must be enclosed with single quotes, and be
pre-encoded based on their destination in the request. The
destination must match the pattern
integration.request.{location}.{name}
, wherelocation
is either querystring, path, or header.name
must be a valid, unique parameter name.
-
setRequestParameters
Represents request parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern
integration.request.{location}.{name}
, wherelocation
is either querystring, path, or header.name
must be a valid, unique parameter name.- Parameters:
requestParameters
- Represents request parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the patternintegration.request.{location}.{name}
, wherelocation
is either querystring, path, or header.name
must be a valid, unique parameter name.
-
withRequestParameters
Represents request parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern
integration.request.{location}.{name}
, wherelocation
is either querystring, path, or header.name
must be a valid, unique parameter name.- Parameters:
requestParameters
- Represents request parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the patternintegration.request.{location}.{name}
, wherelocation
is either querystring, path, or header.name
must be a valid, unique parameter name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addRequestParametersEntry
-
clearRequestParametersEntries
Removes all the entries added into RequestParameters. <p> Returns a reference to this object so that method calls can be chained together. -
getRequestTemplates
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
- Returns:
- Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
-
setRequestTemplates
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
- Parameters:
requestTemplates
- Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
-
withRequestTemplates
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
- Parameters:
requestTemplates
- Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addRequestTemplatesEntry
-
clearRequestTemplatesEntries
Removes all the entries added into RequestTemplates. <p> Returns a reference to this object so that method calls can be chained together. -
setPassthroughBehavior
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values:
WHEN_NO_MATCH
,WHEN_NO_TEMPLATES
, andNEVER
.WHEN_NO_MATCH
passes the request body for unmapped content types through to the Integration backend without transformation.NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.WHEN_NO_TEMPLATES
will allow 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.- Parameters:
passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values:WHEN_NO_MATCH
,WHEN_NO_TEMPLATES
, andNEVER
.WHEN_NO_MATCH
passes the request body for unmapped content types through to the Integration backend without transformation.NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.WHEN_NO_TEMPLATES
will allow 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.
-
getPassthroughBehavior
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values:
WHEN_NO_MATCH
,WHEN_NO_TEMPLATES
, andNEVER
.WHEN_NO_MATCH
passes the request body for unmapped content types through to the Integration backend without transformation.NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.WHEN_NO_TEMPLATES
will allow 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.- Returns:
- Specifies the pass-through behavior for incoming requests based
on the Content-Type header in the request, and the available
requestTemplates defined on the Integration. There are three
valid values:
WHEN_NO_MATCH
,WHEN_NO_TEMPLATES
, andNEVER
.WHEN_NO_MATCH
passes the request body for unmapped content types through to the Integration backend without transformation.NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.WHEN_NO_TEMPLATES
will allow 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.
-
withPassthroughBehavior
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values:
WHEN_NO_MATCH
,WHEN_NO_TEMPLATES
, andNEVER
.WHEN_NO_MATCH
passes the request body for unmapped content types through to the Integration backend without transformation.NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.WHEN_NO_TEMPLATES
will allow 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.- Parameters:
passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values:WHEN_NO_MATCH
,WHEN_NO_TEMPLATES
, andNEVER
.WHEN_NO_MATCH
passes the request body for unmapped content types through to the Integration backend without transformation.NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.WHEN_NO_TEMPLATES
will allow 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCacheNamespace
Specifies a put integration input's cache namespace.
- Parameters:
cacheNamespace
- Specifies a put integration input's cache namespace.
-
getCacheNamespace
Specifies a put integration input's cache namespace.
- Returns:
- Specifies a put integration input's cache namespace.
-
withCacheNamespace
Specifies a put integration input's cache namespace.
- Parameters:
cacheNamespace
- Specifies a put integration input's cache namespace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getCacheKeyParameters
Specifies a put integration input's cache key parameters.
- Returns:
- Specifies a put integration input's cache key parameters.
-
setCacheKeyParameters
Specifies a put integration input's cache key parameters.
- Parameters:
cacheKeyParameters
- Specifies a put integration input's cache key parameters.
-
withCacheKeyParameters
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)
orwithCacheKeyParameters(java.util.Collection)
if you want to override the existing values.- Parameters:
cacheKeyParameters
- Specifies a put integration input's cache key parameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withCacheKeyParameters
Specifies a put integration input's cache key parameters.
- Parameters:
cacheKeyParameters
- Specifies a put integration input's cache key parameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-