Class PutMethodResponseRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Request to add a MethodResponse to an existing Method resource.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddResponseModelsEntry
(String key, String value) addResponseParametersEntry
(String key, Boolean value) Removes all the entries added into ResponseModels.Removes all the entries added into ResponseParameters.clone()
Creates a shallow clone of this request.boolean
The HTTP verb that identifies the Method resource.Specifies the Model resources used for the response's content type.Represents response parameters that can be sent back to the caller by Amazon API Gateway.The method response's status code.int
hashCode()
void
setHttpMethod
(String httpMethod) The HTTP verb that identifies the Method resource.void
setResourceId
(String resourceId) void
setResponseModels
(Map<String, String> responseModels) Specifies the Model resources used for the response's content type.void
setResponseParameters
(Map<String, Boolean> responseParameters) Represents response parameters that can be sent back to the caller by Amazon API Gateway.void
setRestApiId
(String restApiId) void
setStatusCode
(String statusCode) The method response's status code.toString()
Returns a string representation of this object; useful for testing and debugging.withHttpMethod
(String httpMethod) The HTTP verb that identifies the Method resource.withResourceId
(String resourceId) withResponseModels
(Map<String, String> responseModels) Specifies the Model resources used for the response's content type.withResponseParameters
(Map<String, Boolean> responseParameters) Represents response parameters that can be sent back to the caller by Amazon API Gateway.withRestApiId
(String restApiId) withStatusCode
(String statusCode) The method response's status code.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
PutMethodResponseRequest
public PutMethodResponseRequest()
-
-
Method Details
-
setRestApiId
-
getRestApiId
-
withRestApiId
-
setResourceId
-
getResourceId
-
withResourceId
-
setHttpMethod
The HTTP verb that identifies the Method resource.
- Parameters:
httpMethod
- The HTTP verb that identifies the Method resource.
-
getHttpMethod
The HTTP verb that identifies the Method resource.
- Returns:
- The HTTP verb that identifies the Method resource.
-
withHttpMethod
The HTTP verb that identifies the Method resource.
- Parameters:
httpMethod
- The HTTP verb that identifies the Method resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatusCode
The method response's status code.
- Parameters:
statusCode
- The method response's status code.
-
getStatusCode
The method response's status code.
- Returns:
- The method response's status code.
-
withStatusCode
The method response's status code.
- Parameters:
statusCode
- The method response's status code.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getResponseParameters
Represents response parameters that can be sent back to the caller by Amazon API Gateway. Response parameters are represented as a key/value map, with a destination as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A destination must match the pattern
method.response.header.{name}
, wherename
is a valid, unique header name. Destinations specified here are available to the integration for mapping from integration response parameters.- Returns:
- Represents response parameters that can be sent back to the
caller by Amazon API Gateway. Response parameters are represented
as a key/value map, with a destination as the key and a Boolean
flag as the value. The Boolean flag is used to specify whether
the parameter is required. A destination must match the pattern
method.response.header.{name}
, wherename
is a valid, unique header name. Destinations specified here are available to the integration for mapping from integration response parameters.
-
setResponseParameters
Represents response parameters that can be sent back to the caller by Amazon API Gateway. Response parameters are represented as a key/value map, with a destination as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A destination must match the pattern
method.response.header.{name}
, wherename
is a valid, unique header name. Destinations specified here are available to the integration for mapping from integration response parameters.- Parameters:
responseParameters
- Represents response parameters that can be sent back to the caller by Amazon API Gateway. Response parameters are represented as a key/value map, with a destination as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A destination must match the patternmethod.response.header.{name}
, wherename
is a valid, unique header name. Destinations specified here are available to the integration for mapping from integration response parameters.
-
withResponseParameters
Represents response parameters that can be sent back to the caller by Amazon API Gateway. Response parameters are represented as a key/value map, with a destination as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A destination must match the pattern
method.response.header.{name}
, wherename
is a valid, unique header name. Destinations specified here are available to the integration for mapping from integration response parameters.- Parameters:
responseParameters
- Represents response parameters that can be sent back to the caller by Amazon API Gateway. Response parameters are represented as a key/value map, with a destination as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A destination must match the patternmethod.response.header.{name}
, wherename
is a valid, unique header name. Destinations specified here are available to the integration for mapping from integration response parameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addResponseParametersEntry
-
clearResponseParametersEntries
Removes all the entries added into ResponseParameters. <p> Returns a reference to this object so that method calls can be chained together. -
getResponseModels
-
setResponseModels
-
withResponseModels
Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
- Parameters:
responseModels
- Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addResponseModelsEntry
-
clearResponseModelsEntries
Removes all the entries added into ResponseModels. <p> Returns a reference to this object so that method calls can be chained together. -
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-