@Generated(value="software.amazon.awssdk:codegen") public class PutIntegrationRequest extends APIGatewayRequest implements ToCopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>
Sets up a method's integration.
Modifier and Type | Class and Description |
---|---|
static interface |
PutIntegrationRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static PutIntegrationRequest.Builder |
builder() |
List<String> |
cacheKeyParameters()
Specifies a put integration input's cache key parameters.
|
String |
cacheNamespace()
Specifies a put integration input's cache namespace.
|
ContentHandlingStrategy |
contentHandling()
Specifies how to handle request payload content type conversions.
|
String |
contentHandlingString()
Specifies how to handle request payload content type conversions.
|
String |
credentials()
Specifies whether credentials are required for a put integration.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
httpMethod()
Specifies a put integration request's HTTP method.
|
String |
integrationHttpMethod()
Specifies a put integration HTTP method.
|
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. |
Map<String,String> |
requestParameters()
A key-value map specifying request parameters that are passed from the method request to the back end.
|
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.
|
String |
resourceId()
Specifies a put integration request's resource ID.
|
String |
restApiId()
The string identifier of the associated RestApi.
|
static Class<? extends PutIntegrationRequest.Builder> |
serializableBuilderClass() |
PutIntegrationRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
IntegrationType |
type()
Specifies a put integration input's type.
|
String |
typeString()
Specifies a put integration input's type.
|
String |
uri()
Specifies the integration's Uniform Resource Identifier (URI).
|
requestOverrideConfig
copy
public String restApiId()
The string identifier of the associated RestApi.
public String resourceId()
Specifies a put integration request's resource ID.
public String httpMethod()
Specifies a put integration request's HTTP method.
public IntegrationType type()
Specifies a put integration input's type.
If the service returns an enum value that is not available in the current SDK version, type
will return
IntegrationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
IntegrationType
public String typeString()
Specifies a put integration input's type.
If the service returns an enum value that is not available in the current SDK version, type
will return
IntegrationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
IntegrationType
public String integrationHttpMethod()
Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
public 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
/
.
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 /
.public String credentials()
Specifies whether credentials are required for a put integration.
public 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
method.request.{location}.{name}
, where location
is querystring
,
path
, or header
and name
must be a valid and unique method request
parameter name.public 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
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 cacheNamespace()
Specifies a put integration input's cache namespace.
public List<String> cacheKeyParameters()
Specifies a put integration input's cache key parameters.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
If the service returns an enum value that is not available in the current SDK version, contentHandling
will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from contentHandlingString()
.
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 contentHandlingString()
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.
If the service returns an enum value that is not available in the current SDK version, contentHandling
will return ContentHandlingStrategy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from contentHandlingString()
.
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.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>
toBuilder
in class APIGatewayRequest
public static PutIntegrationRequest.Builder builder()
public static Class<? extends PutIntegrationRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.