Class MethodResponse
- java.lang.Object
-
- com.amazonaws.services.apigateway.model.MethodResponse
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class MethodResponse extends Object implements 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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description MethodResponse()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MethodResponse
addResponseModelsEntry(String key, String value)
MethodResponse
addResponseParametersEntry(String key, Boolean value)
MethodResponse
clearResponseModelsEntries()
Removes all the entries added into ResponseModels.MethodResponse
clearResponseParametersEntries()
Removes all the entries added into ResponseParameters.MethodResponse
clone()
boolean
equals(Object obj)
Map<String,String>
getResponseModels()
Specifies the Model resources used for the response's content-type.Map<String,Boolean>
getResponseParameters()
Represents response parameters that can be sent back to the caller by Amazon API Gateway.String
getStatusCode()
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.String
toString()
Returns a string representation of this object; useful for testing and debugging.MethodResponse
withResponseModels(Map<String,String> responseModels)
Specifies the Model resources used for the response's content-type.MethodResponse
withResponseParameters(Map<String,Boolean> responseParameters)
Represents response parameters that can be sent back to the caller by Amazon API Gateway.MethodResponse
withStatusCode(String statusCode)
The method response's status code.
-
-
-
Method Detail
-
setStatusCode
public void setStatusCode(String statusCode)
The method response's status code.
- Parameters:
statusCode
- The method response's status code.
-
getStatusCode
public String getStatusCode()
The method response's status code.
- Returns:
- The method response's status code.
-
withStatusCode
public MethodResponse withStatusCode(String statusCode)
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
public Map<String,Boolean> 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
public void setResponseParameters(Map<String,Boolean> 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 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
public MethodResponse withResponseParameters(Map<String,Boolean> 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 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
public MethodResponse addResponseParametersEntry(String key, Boolean value)
-
clearResponseParametersEntries
public MethodResponse clearResponseParametersEntries()
Removes all the entries added into ResponseParameters. <p> Returns a reference to this object so that method calls can be chained together.
-
withResponseModels
public MethodResponse withResponseModels(Map<String,String> 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.
- 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
public MethodResponse addResponseModelsEntry(String key, String value)
-
clearResponseModelsEntries
public MethodResponse clearResponseModelsEntries()
Removes all the entries added into ResponseModels. <p> Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public MethodResponse clone()
-
-