Class GetMethodResponseResult
- All Implemented Interfaces:
Serializable
,Cloneable
Represents a method response. Amazon API Gateway sends back the status code to the caller as the HTTP status code. Parameters and models can be used to transform the response from the method's integration.
- See Also:
-
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()
boolean
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
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
setStatusCode
(String statusCode) The method response's status code.toString()
Returns a string representation of this object; useful for testing and debugging.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.withStatusCode
(String statusCode) The method response's status code.
-
Constructor Details
-
GetMethodResponseResult
public GetMethodResponseResult()
-
-
Method Details
-
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, which 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, which 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, which 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, which 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, which 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, which 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
-