public class PutIntegrationRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents a put integration request.
Modifier and Type | Field and Description |
---|---|
private java.util.List<java.lang.String> |
cacheKeyParameters
Specifies a put integration input's cache key parameters.
|
private java.lang.String |
cacheNamespace
Specifies a put integration input's cache namespace.
|
private java.lang.String |
credentials
Specifies whether credentials are required for a put integration.
|
private java.lang.String |
httpMethod
Specifies a put integration request's HTTP method.
|
private java.lang.String |
integrationHttpMethod
Specifies a put integration HTTP method.
|
private java.lang.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.
|
private java.util.Map<java.lang.String,java.lang.String> |
requestParameters
Represents request parameters that are sent with the backend request.
|
private java.util.Map<java.lang.String,java.lang.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.
|
private java.lang.String |
resourceId
Specifies a put integration request's resource ID.
|
private java.lang.String |
restApiId
Specifies a put integration request's API identifier.
|
private java.lang.String |
type
Specifies a put integration input's type.
|
private java.lang.String |
uri
Specifies a put integration input's Uniform Resource Identifier (URI).
|
NOOP
Constructor and Description |
---|
PutIntegrationRequest() |
Modifier and Type | Method and Description |
---|---|
PutIntegrationRequest |
addRequestParametersEntry(java.lang.String key,
java.lang.String value) |
PutIntegrationRequest |
addRequestTemplatesEntry(java.lang.String key,
java.lang.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(java.lang.Object obj) |
java.util.List<java.lang.String> |
getCacheKeyParameters()
Specifies a put integration input's cache key parameters.
|
java.lang.String |
getCacheNamespace()
Specifies a put integration input's cache namespace.
|
java.lang.String |
getCredentials()
Specifies whether credentials are required for a put integration.
|
java.lang.String |
getHttpMethod()
Specifies a put integration request's HTTP method.
|
java.lang.String |
getIntegrationHttpMethod()
Specifies a put integration HTTP method.
|
java.lang.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.
|
java.util.Map<java.lang.String,java.lang.String> |
getRequestParameters()
Represents request parameters that are sent with the backend request.
|
java.util.Map<java.lang.String,java.lang.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.
|
java.lang.String |
getResourceId()
Specifies a put integration request's resource ID.
|
java.lang.String |
getRestApiId()
Specifies a put integration request's API identifier.
|
java.lang.String |
getType()
Specifies a put integration input's type.
|
java.lang.String |
getUri()
Specifies a put integration input's Uniform Resource Identifier (URI).
|
int |
hashCode() |
void |
setCacheKeyParameters(java.util.Collection<java.lang.String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
|
void |
setCacheNamespace(java.lang.String cacheNamespace)
Specifies a put integration input's cache namespace.
|
void |
setCredentials(java.lang.String credentials)
Specifies whether credentials are required for a put integration.
|
void |
setHttpMethod(java.lang.String httpMethod)
Specifies a put integration request's HTTP method.
|
void |
setIntegrationHttpMethod(java.lang.String integrationHttpMethod)
Specifies a put integration HTTP method.
|
void |
setPassthroughBehavior(java.lang.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(java.util.Map<java.lang.String,java.lang.String> requestParameters)
Represents request parameters that are sent with the backend request.
|
void |
setRequestTemplates(java.util.Map<java.lang.String,java.lang.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(java.lang.String resourceId)
Specifies a put integration request's resource ID.
|
void |
setRestApiId(java.lang.String restApiId)
Specifies a put integration request's API identifier.
|
void |
setType(IntegrationType type)
Specifies a put integration input's type.
|
void |
setType(java.lang.String type)
Specifies a put integration input's type.
|
void |
setUri(java.lang.String uri)
Specifies a put integration input's Uniform Resource Identifier (URI).
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PutIntegrationRequest |
withCacheKeyParameters(java.util.Collection<java.lang.String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
|
PutIntegrationRequest |
withCacheKeyParameters(java.lang.String... cacheKeyParameters)
Specifies a put integration input's cache key parameters.
|
PutIntegrationRequest |
withCacheNamespace(java.lang.String cacheNamespace)
Specifies a put integration input's cache namespace.
|
PutIntegrationRequest |
withCredentials(java.lang.String credentials)
Specifies whether credentials are required for a put integration.
|
PutIntegrationRequest |
withHttpMethod(java.lang.String httpMethod)
Specifies a put integration request's HTTP method.
|
PutIntegrationRequest |
withIntegrationHttpMethod(java.lang.String integrationHttpMethod)
Specifies a put integration HTTP method.
|
PutIntegrationRequest |
withPassthroughBehavior(java.lang.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(java.util.Map<java.lang.String,java.lang.String> requestParameters)
Represents request parameters that are sent with the backend request.
|
PutIntegrationRequest |
withRequestTemplates(java.util.Map<java.lang.String,java.lang.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(java.lang.String resourceId)
Specifies a put integration request's resource ID.
|
PutIntegrationRequest |
withRestApiId(java.lang.String restApiId)
Specifies a put integration request's API identifier.
|
PutIntegrationRequest |
withType(IntegrationType type)
Specifies a put integration input's type.
|
PutIntegrationRequest |
withType(java.lang.String type)
Specifies a put integration input's type.
|
PutIntegrationRequest |
withUri(java.lang.String uri)
Specifies a put integration input's Uniform Resource Identifier (URI).
|
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
private java.lang.String restApiId
Specifies a put integration request's API identifier.
private java.lang.String resourceId
Specifies a put integration request's resource ID.
private java.lang.String httpMethod
Specifies a put integration request's HTTP method.
private java.lang.String type
Specifies a put integration input's type.
private java.lang.String integrationHttpMethod
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
private java.lang.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.
private java.lang.String credentials
Specifies whether credentials are required for a put integration.
private java.util.Map<java.lang.String,java.lang.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}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.
private java.util.Map<java.lang.String,java.lang.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.
private java.lang.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
, and
NEVER
.
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.
private java.lang.String cacheNamespace
Specifies a put integration input's cache namespace.
private java.util.List<java.lang.String> cacheKeyParameters
Specifies a put integration input's cache key parameters.
public void setRestApiId(java.lang.String restApiId)
Specifies a put integration request's API identifier.
restApiId
- Specifies a put integration request's API identifier.public java.lang.String getRestApiId()
Specifies a put integration request's API identifier.
public PutIntegrationRequest withRestApiId(java.lang.String restApiId)
Specifies a put integration request's API identifier.
restApiId
- Specifies a put integration request's API identifier.public void setResourceId(java.lang.String resourceId)
Specifies a put integration request's resource ID.
resourceId
- Specifies a put integration request's resource ID.public java.lang.String getResourceId()
Specifies a put integration request's resource ID.
public PutIntegrationRequest withResourceId(java.lang.String resourceId)
Specifies a put integration request's resource ID.
resourceId
- Specifies a put integration request's resource ID.public void setHttpMethod(java.lang.String httpMethod)
Specifies a put integration request's HTTP method.
httpMethod
- Specifies a put integration request's HTTP method.public java.lang.String getHttpMethod()
Specifies a put integration request's HTTP method.
public PutIntegrationRequest withHttpMethod(java.lang.String httpMethod)
Specifies a put integration request's HTTP method.
httpMethod
- Specifies a put integration request's HTTP method.public void setType(java.lang.String type)
Specifies a put integration input's type.
type
- Specifies a put integration input's type.IntegrationType
public java.lang.String getType()
Specifies a put integration input's type.
IntegrationType
public PutIntegrationRequest withType(java.lang.String type)
Specifies a put integration input's type.
type
- Specifies a put integration input's type.IntegrationType
public void setType(IntegrationType type)
Specifies a put integration input's type.
type
- Specifies a put integration input's type.IntegrationType
public PutIntegrationRequest withType(IntegrationType type)
Specifies a put integration input's type.
type
- Specifies a put integration input's type.IntegrationType
public void setIntegrationHttpMethod(java.lang.String integrationHttpMethod)
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
integrationHttpMethod
- Specifies a put integration HTTP method. When the integration type
is HTTP or AWS, this field is required.public java.lang.String getIntegrationHttpMethod()
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
public PutIntegrationRequest withIntegrationHttpMethod(java.lang.String integrationHttpMethod)
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
integrationHttpMethod
- Specifies a put integration HTTP method. When the integration type
is HTTP or AWS, this field is required.public void setUri(java.lang.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.
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.public java.lang.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.
public PutIntegrationRequest withUri(java.lang.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.
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.public void setCredentials(java.lang.String credentials)
Specifies whether credentials are required for a put integration.
credentials
- Specifies whether credentials are required for a put integration.public java.lang.String getCredentials()
Specifies whether credentials are required for a put integration.
public PutIntegrationRequest withCredentials(java.lang.String credentials)
Specifies whether credentials are required for a put integration.
credentials
- Specifies whether credentials are required for a put integration.public java.util.Map<java.lang.String,java.lang.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}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.
integration.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.public void setRequestParameters(java.util.Map<java.lang.String,java.lang.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}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.
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}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.public PutIntegrationRequest withRequestParameters(java.util.Map<java.lang.String,java.lang.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}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.
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}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.public PutIntegrationRequest addRequestParametersEntry(java.lang.String key, java.lang.String value)
public PutIntegrationRequest clearRequestParametersEntries()
public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> requestTemplates)
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
requestTemplates
- Represents a map of Velocity templates that are applied on the
request payload based on the value of the Content-Type header sent
by the client. The content type value is the key in this map, and
the template (as a String) is the value.public PutIntegrationRequest withRequestTemplates(java.util.Map<java.lang.String,java.lang.String> requestTemplates)
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
requestTemplates
- Represents a map of Velocity templates that are applied on the
request payload based on the value of the Content-Type header sent
by the client. The content type value is the key in this map, and
the template (as a String) is the value.public PutIntegrationRequest addRequestTemplatesEntry(java.lang.String key, java.lang.String value)
public PutIntegrationRequest clearRequestTemplatesEntries()
public void setPassthroughBehavior(java.lang.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
, and
NEVER
.
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.
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
, and NEVER
.
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.
public java.lang.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
, and
NEVER
.
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.
WHEN_NO_MATCH
,
WHEN_NO_TEMPLATES
, and NEVER
.
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.
public PutIntegrationRequest withPassthroughBehavior(java.lang.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
, and
NEVER
.
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.
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
, and NEVER
.
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.
public void setCacheNamespace(java.lang.String cacheNamespace)
Specifies a put integration input's cache namespace.
cacheNamespace
- Specifies a put integration input's cache namespace.public java.lang.String getCacheNamespace()
Specifies a put integration input's cache namespace.
public PutIntegrationRequest withCacheNamespace(java.lang.String cacheNamespace)
Specifies a put integration input's cache namespace.
cacheNamespace
- Specifies a put integration input's cache namespace.public java.util.List<java.lang.String> getCacheKeyParameters()
Specifies a put integration input's cache key parameters.
public void setCacheKeyParameters(java.util.Collection<java.lang.String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
cacheKeyParameters
- Specifies a put integration input's cache key parameters.public PutIntegrationRequest withCacheKeyParameters(java.lang.String... cacheKeyParameters)
Specifies a put integration input's cache key parameters.
NOTE: This method appends the values to the existing list (if
any). Use setCacheKeyParameters(java.util.Collection)
or
withCacheKeyParameters(java.util.Collection)
if you want to
override the existing values.
cacheKeyParameters
- Specifies a put integration input's cache key parameters.public PutIntegrationRequest withCacheKeyParameters(java.util.Collection<java.lang.String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
cacheKeyParameters
- Specifies a put integration input's cache key parameters.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public PutIntegrationRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()