@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PutIntegrationRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents a put integration request.
NOOP
Constructor and Description |
---|
PutIntegrationRequest() |
Modifier and Type | Method and 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 |
getContentHandling()
Specifies how to handle request payload content type conversions.
|
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 mapping templates specified as the
requestTemplates property on the Integration
resource. |
Map<String,String> |
getRequestParameters()
A key-value map specifying request parameters that are passed from the method request to the back end.
|
Map<String,String> |
getRequestTemplates()
Represents a map of Velocity templates that are applied on the request payload based on the value of the
Content-Type header sent by the client.
|
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 |
setContentHandling(ContentHandlingStrategy contentHandling)
Specifies how to handle request payload content type conversions.
|
void |
setContentHandling(String contentHandling)
Specifies how to handle request payload content type conversions.
|
void |
setCredentials(String credentials)
Specifies 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 mapping templates specified as the
requestTemplates property on the Integration
resource. |
void |
setRequestParameters(Map<String,String> requestParameters)
A key-value map specifying request parameters that are passed from the method request to the back end.
|
void |
setRequestTemplates(Map<String,String> requestTemplates)
Represents a map of Velocity templates that are applied on the request payload based on the value of the
Content-Type header sent by the client.
|
void |
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(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
|
PutIntegrationRequest |
withCacheKeyParameters(String... cacheKeyParameters)
Specifies a put integration input's cache key parameters.
|
PutIntegrationRequest |
withCacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
|
PutIntegrationRequest |
withContentHandling(ContentHandlingStrategy contentHandling)
Specifies how to handle request payload content type conversions.
|
PutIntegrationRequest |
withContentHandling(String contentHandling)
Specifies how to handle request payload content type conversions.
|
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 mapping templates specified as the
requestTemplates property on the Integration
resource. |
PutIntegrationRequest |
withRequestParameters(Map<String,String> requestParameters)
A key-value map specifying request parameters that are passed from the method request to the back end.
|
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).
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setRestApiId(String restApiId)
Specifies a put integration request's API identifier.
restApiId
- Specifies a put integration request's API identifier.public String getRestApiId()
Specifies a put integration request's API identifier.
public PutIntegrationRequest withRestApiId(String restApiId)
Specifies a put integration request's API identifier.
restApiId
- Specifies a put integration request's API identifier.public void setResourceId(String resourceId)
Specifies a put integration request's resource ID.
resourceId
- Specifies a put integration request's resource ID.public String getResourceId()
Specifies a put integration request's resource ID.
public PutIntegrationRequest withResourceId(String resourceId)
Specifies a put integration request's resource ID.
resourceId
- Specifies a put integration request's resource ID.public void setHttpMethod(String httpMethod)
Specifies a put integration request's HTTP method.
httpMethod
- Specifies a put integration request's HTTP method.public String getHttpMethod()
Specifies a put integration request's HTTP method.
public PutIntegrationRequest withHttpMethod(String httpMethod)
Specifies a put integration request's HTTP method.
httpMethod
- Specifies a put integration request's HTTP method.public void setType(String type)
Specifies a put integration input's type.
type
- Specifies a put integration input's type.IntegrationType
public String getType()
Specifies a put integration input's type.
IntegrationType
public PutIntegrationRequest withType(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(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 String getIntegrationHttpMethod()
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
public PutIntegrationRequest withIntegrationHttpMethod(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(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 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(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(String credentials)
Specifies whether credentials are required for a put integration.
credentials
- Specifies whether credentials are required for a put integration.public String getCredentials()
Specifies whether credentials are required for a put integration.
public PutIntegrationRequest withCredentials(String credentials)
Specifies whether credentials are required for a put integration.
credentials
- Specifies whether credentials are required for a put integration.public Map<String,String> getRequestParameters()
A key-value map specifying request parameters that are passed from the method request to the back end. The key is
an integration request parameter name and the associated value is a method request parameter value or static
value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request
parameter value must match the pattern of method.request.{location}.{name}
, where
location
is querystring
, path
, or header
and
name
must be a valid and unique method request parameter name.
method.request.{location}.{name}
, where location
is querystring
,
path
, or header
and name
must be a valid and unique method request
parameter name.public void setRequestParameters(Map<String,String> requestParameters)
A key-value map specifying request parameters that are passed from the method request to the back end. The key is
an integration request parameter name and the associated value is a method request parameter value or static
value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request
parameter value must match the pattern of method.request.{location}.{name}
, where
location
is querystring
, path
, or header
and
name
must be a valid and unique method request parameter name.
requestParameters
- A key-value map specifying request parameters that are passed from the method request to the back end. The
key is an integration request parameter name and the associated value is a method request parameter value
or static value that must be enclosed within single quotes and pre-encoded as required by the back end.
The method request parameter value must match the pattern of method.request.{location}.{name}
, where location
is querystring
, path
, or header
and
name
must be a valid and unique method request parameter name.public PutIntegrationRequest withRequestParameters(Map<String,String> requestParameters)
A key-value map specifying request parameters that are passed from the method request to the back end. The key is
an integration request parameter name and the associated value is a method request parameter value or static
value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request
parameter value must match the pattern of method.request.{location}.{name}
, where
location
is querystring
, path
, or header
and
name
must be a valid and unique method request parameter name.
requestParameters
- A key-value map specifying request parameters that are passed from the method request to the back end. The
key is an integration request parameter name and the associated value is a method request parameter value
or static value that must be enclosed within single quotes and pre-encoded as required by the back end.
The method request parameter value must match the pattern of method.request.{location}.{name}
, where location
is querystring
, path
, or header
and
name
must be a valid and unique method request parameter name.public PutIntegrationRequest addRequestParametersEntry(String key, String value)
public PutIntegrationRequest clearRequestParametersEntries()
public Map<String,String> getRequestTemplates()
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
public void setRequestTemplates(Map<String,String> requestTemplates)
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
requestTemplates
- Represents a map of Velocity templates that are applied on the request payload based on the value of the
Content-Type header sent by the client. The content type value is the key in this map, and the template
(as a String) is the value.public 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.
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(String key, String value)
public PutIntegrationRequest clearRequestTemplatesEntries()
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 mapping templates specified as the requestTemplates
property on the Integration
resource. 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 back end
without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows 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 mapping templates specified as the requestTemplates
property on the
Integration resource. 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
back end without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows 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 String getPassthroughBehavior()
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
, and
NEVER
.
WHEN_NO_MATCH
passes the request body for unmapped content types through to the integration back end
without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows 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.
requestTemplates
property on
the Integration resource. 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
back end without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows 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(String 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
, and
NEVER
.
WHEN_NO_MATCH
passes the request body for unmapped content types through to the integration back end
without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows 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 mapping templates specified as the requestTemplates
property on the
Integration resource. 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
back end without transformation.
NEVER
rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
WHEN_NO_TEMPLATES
allows 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(String cacheNamespace)
Specifies a put integration input's cache namespace.
cacheNamespace
- Specifies a put integration input's cache namespace.public String getCacheNamespace()
Specifies a put integration input's cache namespace.
public PutIntegrationRequest withCacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
cacheNamespace
- Specifies a put integration input's cache namespace.public List<String> getCacheKeyParameters()
Specifies a put integration input's cache key parameters.
public void setCacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
cacheKeyParameters
- Specifies a put integration input's cache key parameters.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)
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(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
cacheKeyParameters
- Specifies a put integration input's cache key parameters.public void setContentHandling(String contentHandling)
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the corresponding
binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
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 passthroughBehaviors
is configured to
support payload pass-through.
contentHandling
- Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the
corresponding binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
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 passthroughBehaviors
is
configured to support payload pass-through.
ContentHandlingStrategy
public String getContentHandling()
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the corresponding
binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
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 passthroughBehaviors
is configured to
support payload pass-through.
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the
corresponding binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
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 passthroughBehaviors
is
configured to support payload pass-through.
ContentHandlingStrategy
public PutIntegrationRequest withContentHandling(String contentHandling)
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the corresponding
binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
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 passthroughBehaviors
is configured to
support payload pass-through.
contentHandling
- Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the
corresponding binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
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 passthroughBehaviors
is
configured to support payload pass-through.
ContentHandlingStrategy
public void setContentHandling(ContentHandlingStrategy contentHandling)
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the corresponding
binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
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 passthroughBehaviors
is configured to
support payload pass-through.
contentHandling
- Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the
corresponding binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
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 passthroughBehaviors
is
configured to support payload pass-through.
ContentHandlingStrategy
public PutIntegrationRequest withContentHandling(ContentHandlingStrategy contentHandling)
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the corresponding
binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
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 passthroughBehaviors
is configured to
support payload pass-through.
contentHandling
- Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
and CONVERT_TO_TEXT
, with the following behaviors:
CONVERT_TO_BINARY
: Converts a request payload from a Base64-encoded string to the
corresponding binary blob.
CONVERT_TO_TEXT
: Converts a request payload from a binary blob to a Base64-encoded string.
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 passthroughBehaviors
is
configured to support payload pass-through.
ContentHandlingStrategy
public String toString()
toString
in class Object
Object.toString()
public PutIntegrationRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.