public static interface PutIntegrationRequest.Builder extends ApiGatewayRequest.Builder, CopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>
Modifier and Type | Method and Description |
---|---|
PutIntegrationRequest.Builder |
cacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
|
PutIntegrationRequest.Builder |
cacheKeyParameters(String... cacheKeyParameters)
Specifies a put integration input's cache key parameters.
|
PutIntegrationRequest.Builder |
cacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
|
PutIntegrationRequest.Builder |
contentHandling(ContentHandlingStrategy contentHandling)
Specifies how to handle request payload content type conversions.
|
PutIntegrationRequest.Builder |
contentHandling(String contentHandling)
Specifies how to handle request payload content type conversions.
|
PutIntegrationRequest.Builder |
credentials(String credentials)
Specifies whether credentials are required for a put integration.
|
PutIntegrationRequest.Builder |
httpMethod(String httpMethod)
Specifies a put integration request's HTTP method.
|
PutIntegrationRequest.Builder |
integrationHttpMethod(String integrationHttpMethod)
Specifies a put integration HTTP method.
|
PutIntegrationRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
PutIntegrationRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
PutIntegrationRequest.Builder |
passthroughBehavior(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.Builder |
requestParameters(Map<String,String> requestParameters)
A key-value map specifying request parameters that are passed from the method request to the back end.
|
PutIntegrationRequest.Builder |
requestTemplates(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.Builder |
resourceId(String resourceId)
Specifies a put integration request's resource ID.
|
PutIntegrationRequest.Builder |
restApiId(String restApiId)
The string identifier of the associated RestApi.
|
PutIntegrationRequest.Builder |
type(IntegrationType type)
Specifies a put integration input's type.
|
PutIntegrationRequest.Builder |
type(String type)
Specifies a put integration input's type.
|
PutIntegrationRequest.Builder |
uri(String uri)
Specifies the integration's Uniform Resource Identifier (URI).
|
build
overrideConfiguration
copy
applyMutation, build
PutIntegrationRequest.Builder restApiId(String restApiId)
The string identifier of the associated RestApi.
restApiId
- The string identifier of the associated RestApi.PutIntegrationRequest.Builder resourceId(String resourceId)
Specifies a put integration request's resource ID.
resourceId
- Specifies a put integration request's resource ID.PutIntegrationRequest.Builder httpMethod(String httpMethod)
Specifies a put integration request's HTTP method.
httpMethod
- Specifies a put integration request's HTTP method.PutIntegrationRequest.Builder type(String type)
Specifies a put integration input's type.
type
- Specifies a put integration input's type.IntegrationType
,
IntegrationType
PutIntegrationRequest.Builder type(IntegrationType type)
Specifies a put integration input's type.
type
- Specifies a put integration input's type.IntegrationType
,
IntegrationType
PutIntegrationRequest.Builder integrationHttpMethod(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.PutIntegrationRequest.Builder uri(String uri)
Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully
formed, encoded HTTP(S) URL according to the RFC-3986 specification.
For AWS integrations, the URI should be of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}
.
Region
, subdomain
and service
are used to determine the right
endpoint. For AWS services that use the Action=
query string parameter, service_api
should be a valid action for the desired service. For RESTful AWS service APIs, path
is used to
indicate that the remaining substring in the URI should be treated as the path to the resource, including the
initial /
.
uri
- Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be
a fully formed, encoded HTTP(S) URL according to the RFC-3986
specification. For AWS integrations, the URI should be of the form
arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}
.
Region
, subdomain
and service
are used to determine the right
endpoint. For AWS services that use the Action=
query string parameter,
service_api
should be a valid action for the desired service. For RESTful AWS service
APIs, path
is used to indicate that the remaining substring in the URI should be treated
as the path to the resource, including the initial /
.PutIntegrationRequest.Builder credentials(String credentials)
Specifies whether credentials are required for a put integration.
credentials
- Specifies whether credentials are required for a put integration.PutIntegrationRequest.Builder requestParameters(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.PutIntegrationRequest.Builder requestTemplates(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.PutIntegrationRequest.Builder passthroughBehavior(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.
PutIntegrationRequest.Builder cacheNamespace(String cacheNamespace)
Specifies a put integration input's cache namespace.
cacheNamespace
- Specifies a put integration input's cache namespace.PutIntegrationRequest.Builder cacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies a put integration input's cache key parameters.
cacheKeyParameters
- Specifies a put integration input's cache key parameters.PutIntegrationRequest.Builder cacheKeyParameters(String... cacheKeyParameters)
Specifies a put integration input's cache key parameters.
cacheKeyParameters
- Specifies a put integration input's cache key parameters.PutIntegrationRequest.Builder contentHandling(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
,
ContentHandlingStrategy
PutIntegrationRequest.Builder contentHandling(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
,
ContentHandlingStrategy
PutIntegrationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.PutIntegrationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.