Class PutIntegrationRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.apigateway.model.PutIntegrationRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class PutIntegrationRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents a put integration request.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description PutIntegrationRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PutIntegrationRequest
addRequestParametersEntry(String key, String value)
PutIntegrationRequest
addRequestTemplatesEntry(String key, String value)
PutIntegrationRequest
clearRequestParametersEntries()
Removes all the entries added into RequestParameters.PutIntegrationRequest
clearRequestTemplatesEntries()
Removes all the entries added into RequestTemplates.PutIntegrationRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
List<String>
getCacheKeyParameters()
Specifies a put integration input's cache key parameters.String
getCacheNamespace()
Specifies a put integration input's cache namespace.String
getCredentials()
Specifies whether credentials are required for a put integration.String
getHttpMethod()
Specifies a put integration request's HTTP method.String
getIntegrationHttpMethod()
Specifies a put integration HTTP method.String
getPassthroughBehavior()
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration.Map<String,String>
getRequestParameters()
Represents request parameters that are sent with the backend request.Map<String,String>
getRequestTemplates()
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.String
getResourceId()
Specifies a put integration request's resource ID.String
getRestApiId()
Specifies a put integration request's API identifier.String
getType()
Specifies a put integration input's type.String
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
setType(String type)
Specifies a put integration input's type.void
setUri(String uri)
Specifies a put integration input's Uniform Resource Identifier (URI).String
toString()
Returns a string representation of this object; useful for testing and debugging.PutIntegrationRequest
withCacheKeyParameters(String... cacheKeyParameters)
Specifies a put integration input's cache key parameters.PutIntegrationRequest
withCacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.PutIntegrationRequest
withCacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.PutIntegrationRequest
withCredentials(String credentials)
Specifies whether credentials are required for a put integration.PutIntegrationRequest
withHttpMethod(String httpMethod)
Specifies a put integration request's HTTP method.PutIntegrationRequest
withIntegrationHttpMethod(String integrationHttpMethod)
Specifies a put integration HTTP method.PutIntegrationRequest
withPassthroughBehavior(String passthroughBehavior)
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration.PutIntegrationRequest
withRequestParameters(Map<String,String> requestParameters)
Represents request parameters that are sent with the backend request.PutIntegrationRequest
withRequestTemplates(Map<String,String> requestTemplates)
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.PutIntegrationRequest
withResourceId(String resourceId)
Specifies a put integration request's resource ID.PutIntegrationRequest
withRestApiId(String restApiId)
Specifies a put integration request's API identifier.PutIntegrationRequest
withType(IntegrationType type)
Specifies a put integration input's type.PutIntegrationRequest
withType(String type)
Specifies a put integration input's type.PutIntegrationRequest
withUri(String uri)
Specifies 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
-
-
-
-
Method Detail
-
setRestApiId
public void setRestApiId(String restApiId)
Specifies a put integration request's API identifier.
- Parameters:
restApiId
- Specifies a put integration request's API identifier.
-
getRestApiId
public String getRestApiId()
Specifies a put integration request's API identifier.
- Returns:
- Specifies a put integration request's API identifier.
-
withRestApiId
public PutIntegrationRequest withRestApiId(String restApiId)
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
public void setResourceId(String resourceId)
Specifies a put integration request's resource ID.
- Parameters:
resourceId
- Specifies a put integration request's resource ID.
-
getResourceId
public String getResourceId()
Specifies a put integration request's resource ID.
- Returns:
- Specifies a put integration request's resource ID.
-
withResourceId
public PutIntegrationRequest withResourceId(String resourceId)
Specifies a put integration request's resource ID.
- Parameters:
resourceId
- Specifies a put integration request's resource ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHttpMethod
public void setHttpMethod(String httpMethod)
Specifies a put integration request's HTTP method.
- Parameters:
httpMethod
- Specifies a put integration request's HTTP method.
-
getHttpMethod
public String getHttpMethod()
Specifies a put integration request's HTTP method.
- Returns:
- Specifies a put integration request's HTTP method.
-
withHttpMethod
public PutIntegrationRequest withHttpMethod(String httpMethod)
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
public void setType(String type)
Specifies a put integration input's type.
- Parameters:
type
- Specifies a put integration input's type.- See Also:
IntegrationType
-
getType
public String getType()
Specifies a put integration input's type.
- Returns:
- Specifies a put integration input's type.
- See Also:
IntegrationType
-
withType
public PutIntegrationRequest withType(String type)
Specifies a put integration input's type.
- Parameters:
type
- Specifies a put integration input's type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IntegrationType
-
setType
public void setType(IntegrationType type)
Specifies a put integration input's type.
- Parameters:
type
- Specifies a put integration input's type.- See Also:
IntegrationType
-
withType
public PutIntegrationRequest withType(IntegrationType type)
Specifies a put integration input's type.
- Parameters:
type
- Specifies a put integration input's type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
IntegrationType
-
setIntegrationHttpMethod
public void setIntegrationHttpMethod(String integrationHttpMethod)
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
public String 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
public PutIntegrationRequest withIntegrationHttpMethod(String integrationHttpMethod)
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
public void setUri(String 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.
- 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
public String 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
public PutIntegrationRequest withUri(String 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.
- 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
public void setCredentials(String credentials)
Specifies whether credentials are required for a put integration.
- Parameters:
credentials
- Specifies whether credentials are required for a put integration.
-
getCredentials
public String getCredentials()
Specifies whether credentials are required for a put integration.
- Returns:
- Specifies whether credentials are required for a put integration.
-
withCredentials
public PutIntegrationRequest withCredentials(String credentials)
Specifies whether credentials are required for a put integration.
- Parameters:
credentials
- Specifies whether credentials are required for a put integration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getRequestParameters
public Map<String,String> getRequestParameters()
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
public void setRequestParameters(Map<String,String> 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 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
public PutIntegrationRequest withRequestParameters(Map<String,String> 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 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
public PutIntegrationRequest addRequestParametersEntry(String key, String value)
-
clearRequestParametersEntries
public PutIntegrationRequest clearRequestParametersEntries()
Removes all the entries added into RequestParameters. <p> Returns a reference to this object so that method calls can be chained together.
-
getRequestTemplates
public Map<String,String> getRequestTemplates()
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
- Returns:
- Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
-
setRequestTemplates
public void setRequestTemplates(Map<String,String> requestTemplates)
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
- Parameters:
requestTemplates
- Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
-
withRequestTemplates
public PutIntegrationRequest withRequestTemplates(Map<String,String> requestTemplates)
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
- Parameters:
requestTemplates
- Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addRequestTemplatesEntry
public PutIntegrationRequest addRequestTemplatesEntry(String key, String value)
-
clearRequestTemplatesEntries
public PutIntegrationRequest clearRequestTemplatesEntries()
Removes all the entries added into RequestTemplates. <p> Returns a reference to this object so that method calls can be chained together.
-
setPassthroughBehavior
public void setPassthroughBehavior(String passthroughBehavior)
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available 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
public String 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
public PutIntegrationRequest withPassthroughBehavior(String passthroughBehavior)
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available 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
public void setCacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
- Parameters:
cacheNamespace
- Specifies a put integration input's cache namespace.
-
getCacheNamespace
public String getCacheNamespace()
Specifies a put integration input's cache namespace.
- Returns:
- Specifies a put integration input's cache namespace.
-
withCacheNamespace
public PutIntegrationRequest withCacheNamespace(String cacheNamespace)
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
public List<String> getCacheKeyParameters()
Specifies a put integration input's cache key parameters.
- Returns:
- Specifies a put integration input's cache key parameters.
-
setCacheKeyParameters
public void setCacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
- Parameters:
cacheKeyParameters
- Specifies a put integration input's cache key parameters.
-
withCacheKeyParameters
public PutIntegrationRequest withCacheKeyParameters(String... cacheKeyParameters)
Specifies a put integration input's cache key parameters.
NOTE: This method appends the values to the existing list (if any). Use
setCacheKeyParameters(java.util.Collection)
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
public PutIntegrationRequest withCacheKeyParameters(Collection<String> cacheKeyParameters)
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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public PutIntegrationRequest 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:
Object.clone()
-
-