@Generated(value="software.amazon.awssdk:codegen") public final class UpdateIntegrationResponse extends ApiGatewayResponse implements ToCopyableBuilder<UpdateIntegrationResponse.Builder,UpdateIntegrationResponse>
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateIntegrationResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static UpdateIntegrationResponse.Builder |
builder() |
List<String> |
cacheKeyParameters()
Specifies the integration's cache key parameters.
|
String |
cacheNamespace()
Specifies the integration's cache namespace.
|
ContentHandlingStrategy |
contentHandling()
Specifies how to handle request payload content type conversions.
|
String |
contentHandlingAsString()
Specifies how to handle request payload content type conversions.
|
String |
credentials()
Specifies the credentials required for the integration, if any.
|
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
SdkResponse . |
int |
hashCode() |
String |
httpMethod()
Specifies the integration's HTTP method type.
|
Map<String,IntegrationResponse> |
integrationResponses()
Specifies the integration's responses.
|
String |
passthroughBehavior() |
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.
|
static Class<? extends UpdateIntegrationResponse.Builder> |
serializableBuilderClass() |
UpdateIntegrationResponse.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 the integration's type.
|
String |
typeAsString()
Specifies the integration's type.
|
String |
uri()
Specifies the integration's Uniform Resource Identifier (URI).
|
sdkHttpResponse
copy
public IntegrationType type()
Specifies the integration's type. The valid value is HTTP
for integrating with an HTTP back end,
AWS
for any AWS service endpoints, MOCK
for testing without actually invoking the back
end, HTTP_PROXY
for integrating with the HTTP proxy integration, or AWS_PROXY
for
integrating with the Lambda proxy integration 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
typeAsString()
.
HTTP
for integrating with an HTTP back
end, AWS
for any AWS service endpoints, MOCK
for testing without actually
invoking the back end, HTTP_PROXY
for integrating with the HTTP proxy integration, or
AWS_PROXY
for integrating with the Lambda proxy integration type.IntegrationType
public String typeAsString()
Specifies the integration's type. The valid value is HTTP
for integrating with an HTTP back end,
AWS
for any AWS service endpoints, MOCK
for testing without actually invoking the back
end, HTTP_PROXY
for integrating with the HTTP proxy integration, or AWS_PROXY
for
integrating with the Lambda proxy integration 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
typeAsString()
.
HTTP
for integrating with an HTTP back
end, AWS
for any AWS service endpoints, MOCK
for testing without actually
invoking the back end, HTTP_PROXY
for integrating with the HTTP proxy integration, or
AWS_PROXY
for integrating with the Lambda proxy integration type.IntegrationType
public String httpMethod()
Specifies the integration's HTTP method type.
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 the credentials required for the integration, if any. For AWS integrations, three options are
available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To
require that the caller's identity be passed through from the request, specify the string
arn:aws:iam::\*:user/\*
. To use resource-based permissions on supported AWS services, specify null.
arn:aws:iam::\*:user/\*
. To use resource-based permissions on supported AWS services,
specify null.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 how the method request body of an unmapped content type will be passed through the integration request
to the back end without transformation. A content type is unmapped if no mapping template is defined in the
integration or the content type does not match any of the mapped content types, as specified in
requestTemplates
. There are three valid values: WHEN_NO_MATCH
,
WHEN_NO_TEMPLATES
, and NEVER
.
WHEN_NO_MATCH
passes the method request body through the integration request to the back end
without transformation when the method request content type does not match any content type associated with the
mapping templates defined in the integration request.WHEN_NO_TEMPLATES
passes the method request body through the integration request to the back end
without transformation when no mapping template is defined in the integration request. If a template is defined
when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP
415 Unsupported Media Type
response.NEVER
rejects the method request with an HTTP 415 Unsupported Media Type
response
when either the method request content type does not match any content type associated with the mapping templates
defined in the integration request or no mapping template is defined in the integration request.
Specifies how the method request body of an unmapped content type will be passed through the integration
request to the back end without transformation. A content type is unmapped if no mapping template is
defined in the integration or the content type does not match any of the mapped content types, as
specified in requestTemplates
. There are three valid values: WHEN_NO_MATCH
,
WHEN_NO_TEMPLATES
, and NEVER
.
WHEN_NO_MATCH
passes the method request body through the integration request to the back
end without transformation when the method request content type does not match any content type
associated with the mapping templates defined in the integration request.WHEN_NO_TEMPLATES
passes the method request body through the integration request to the
back end without transformation when no mapping template is defined in the integration request. If a
template is defined when this option is selected, the method request of an unmapped content-type will be
rejected with an HTTP 415 Unsupported Media Type
response.NEVER
rejects the method request with an HTTP 415 Unsupported Media Type
response when either the method request content type does not match any content type associated with the
mapping templates defined in the integration request or no mapping template is defined in the integration
request.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 contentHandlingAsString()
.
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 contentHandlingAsString()
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 contentHandlingAsString()
.
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 cacheNamespace()
Specifies the integration's cache namespace.
public List<String> cacheKeyParameters()
Specifies the integration's cache key parameters.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Map<String,IntegrationResponse> integrationResponses()
Specifies the integration's responses.
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
The successful response returns 200 OK
status and a payload as follows:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
The successful response returns 200 OK
status and a payload as follows:
{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
public UpdateIntegrationResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateIntegrationResponse.Builder,UpdateIntegrationResponse>
toBuilder
in class AwsResponse
public static UpdateIntegrationResponse.Builder builder()
public static Class<? extends UpdateIntegrationResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. 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 SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
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.