public class UpdateIntegrationResult extends Object implements Serializable, Cloneable
Represents an HTTP, AWS, or Mock integration.
Constructor and Description |
---|
UpdateIntegrationResult() |
Modifier and Type | Method and Description |
---|---|
UpdateIntegrationResult |
addIntegrationResponsesEntry(String key,
IntegrationResponse value) |
UpdateIntegrationResult |
addRequestParametersEntry(String key,
String value) |
UpdateIntegrationResult |
addRequestTemplatesEntry(String key,
String value) |
UpdateIntegrationResult |
clearIntegrationResponsesEntries()
Removes all the entries added into IntegrationResponses.
|
UpdateIntegrationResult |
clearRequestParametersEntries()
Removes all the entries added into RequestParameters.
|
UpdateIntegrationResult |
clearRequestTemplatesEntries()
Removes all the entries added into RequestTemplates.
|
UpdateIntegrationResult |
clone() |
boolean |
equals(Object obj) |
List<String> |
getCacheKeyParameters()
Specifies the integration's cache key parameters.
|
String |
getCacheNamespace()
Specifies the integration's cache namespace.
|
String |
getCredentials()
Specifies the credentials required for the integration, if any.
|
String |
getHttpMethod()
Specifies the integration's HTTP method type.
|
Map<String,IntegrationResponse> |
getIntegrationResponses()
Specifies the integration's responses.
|
String |
getPassthroughBehavior() |
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 |
getType()
Specifies the integration's type.
|
String |
getUri()
Specifies the integration's Uniform Resource Identifier (URI).
|
int |
hashCode() |
void |
setCacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies the integration's cache key parameters.
|
void |
setCacheNamespace(String cacheNamespace)
Specifies the integration's cache namespace.
|
void |
setCredentials(String credentials)
Specifies the credentials required for the integration, if any.
|
void |
setHttpMethod(String httpMethod)
Specifies the integration's HTTP method type.
|
void |
setIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)
Specifies the integration's responses.
|
void |
setPassthroughBehavior(String passthroughBehavior) |
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 |
setType(IntegrationType type)
Specifies the integration's type.
|
void |
setType(String type)
Specifies the integration's type.
|
void |
setUri(String uri)
Specifies the integration's Uniform Resource Identifier (URI).
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateIntegrationResult |
withCacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies the integration's cache key parameters.
|
UpdateIntegrationResult |
withCacheKeyParameters(String... cacheKeyParameters)
Specifies the integration's cache key parameters.
|
UpdateIntegrationResult |
withCacheNamespace(String cacheNamespace)
Specifies the integration's cache namespace.
|
UpdateIntegrationResult |
withCredentials(String credentials)
Specifies the credentials required for the integration, if any.
|
UpdateIntegrationResult |
withHttpMethod(String httpMethod)
Specifies the integration's HTTP method type.
|
UpdateIntegrationResult |
withIntegrationResponses(Map<String,IntegrationResponse> integrationResponses)
Specifies the integration's responses.
|
UpdateIntegrationResult |
withPassthroughBehavior(String passthroughBehavior) |
UpdateIntegrationResult |
withRequestParameters(Map<String,String> requestParameters)
A key-value map specifying request parameters that are passed from the
method request to the back end.
|
UpdateIntegrationResult |
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.
|
UpdateIntegrationResult |
withType(IntegrationType type)
Specifies the integration's type.
|
UpdateIntegrationResult |
withType(String type)
Specifies the integration's type.
|
UpdateIntegrationResult |
withUri(String uri)
Specifies the integration's Uniform Resource Identifier (URI).
|
public void setType(String type)
Specifies the integration's type. The valid value is HTTP
,
AWS
, or MOCK
.
type
- Specifies the integration's type. The valid value is
HTTP
, AWS
, or MOCK
.IntegrationType
public String getType()
Specifies the integration's type. The valid value is HTTP
,
AWS
, or MOCK
.
HTTP
, AWS
, or MOCK
.IntegrationType
public UpdateIntegrationResult withType(String type)
Specifies the integration's type. The valid value is HTTP
,
AWS
, or MOCK
.
type
- Specifies the integration's type. The valid value is
HTTP
, AWS
, or MOCK
.IntegrationType
public void setType(IntegrationType type)
Specifies the integration's type. The valid value is HTTP
,
AWS
, or MOCK
.
type
- Specifies the integration's type. The valid value is
HTTP
, AWS
, or MOCK
.IntegrationType
public UpdateIntegrationResult withType(IntegrationType type)
Specifies the integration's type. The valid value is HTTP
,
AWS
, or MOCK
.
type
- Specifies the integration's type. The valid value is
HTTP
, AWS
, or MOCK
.IntegrationType
public void setHttpMethod(String httpMethod)
Specifies the integration's HTTP method type.
httpMethod
- Specifies the integration's HTTP method type.public String getHttpMethod()
Specifies the integration's HTTP method type.
public UpdateIntegrationResult withHttpMethod(String httpMethod)
Specifies the integration's HTTP method type.
httpMethod
- Specifies the integration's HTTP method type.public void setUri(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 /
.public String getUri()
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 UpdateIntegrationResult withUri(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 /
.public void setCredentials(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.
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.public String getCredentials()
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 UpdateIntegrationResult withCredentials(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.
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.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 UpdateIntegrationResult 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 UpdateIntegrationResult addRequestParametersEntry(String key, String value)
public UpdateIntegrationResult 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 UpdateIntegrationResult 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 UpdateIntegrationResult addRequestTemplatesEntry(String key, String value)
public UpdateIntegrationResult clearRequestTemplatesEntries()
public void setPassthroughBehavior(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.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.public String getPassthroughBehavior()
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 UpdateIntegrationResult withPassthroughBehavior(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.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.public void setCacheNamespace(String cacheNamespace)
Specifies the integration's cache namespace.
cacheNamespace
- Specifies the integration's cache namespace.public String getCacheNamespace()
Specifies the integration's cache namespace.
public UpdateIntegrationResult withCacheNamespace(String cacheNamespace)
Specifies the integration's cache namespace.
cacheNamespace
- Specifies the integration's cache namespace.public List<String> getCacheKeyParameters()
Specifies the integration's cache key parameters.
public void setCacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies the integration's cache key parameters.
cacheKeyParameters
- Specifies the integration's cache key parameters.public UpdateIntegrationResult withCacheKeyParameters(String... cacheKeyParameters)
Specifies the integration'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 the integration's cache key parameters.public UpdateIntegrationResult withCacheKeyParameters(Collection<String> cacheKeyParameters)
Specifies the integration's cache key parameters.
cacheKeyParameters
- Specifies the integration's cache key parameters.public Map<String,IntegrationResponse> getIntegrationResponses()
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" }
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 void setIntegrationResponses(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" }
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" }
public UpdateIntegrationResult withIntegrationResponses(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" }
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" }
public UpdateIntegrationResult addIntegrationResponsesEntry(String key, IntegrationResponse value)
public UpdateIntegrationResult clearIntegrationResponsesEntries()
public String toString()
toString
in class Object
Object.toString()
public UpdateIntegrationResult clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.