@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateMethodResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
Constructor and Description |
---|
UpdateMethodResponseResult() |
Modifier and Type | Method and Description |
---|---|
UpdateMethodResponseResult |
addResponseModelsEntry(String key,
String value)
Add a single ResponseModels entry
|
UpdateMethodResponseResult |
addResponseParametersEntry(String key,
Boolean value)
Add a single ResponseParameters entry
|
UpdateMethodResponseResult |
clearResponseModelsEntries()
Removes all the entries added into ResponseModels.
|
UpdateMethodResponseResult |
clearResponseParametersEntries()
Removes all the entries added into ResponseParameters.
|
UpdateMethodResponseResult |
clone() |
boolean |
equals(Object obj) |
Map<String,String> |
getResponseModels()
Specifies the Model resources used for the response's content-type.
|
Map<String,Boolean> |
getResponseParameters()
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
|
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)
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
|
void |
setStatusCode(String statusCode)
The method response's status code.
|
String |
toString()
Returns a string representation of this object.
|
UpdateMethodResponseResult |
withResponseModels(Map<String,String> responseModels)
Specifies the Model resources used for the response's content-type.
|
UpdateMethodResponseResult |
withResponseParameters(Map<String,Boolean> responseParameters)
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
|
UpdateMethodResponseResult |
withStatusCode(String statusCode)
The method response's status code.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setStatusCode(String statusCode)
The method response's status code.
statusCode
- The method response's status code.public String getStatusCode()
The method response's status code.
public UpdateMethodResponseResult withStatusCode(String statusCode)
The method response's status code.
statusCode
- The method response's status code.public Map<String,Boolean> getResponseParameters()
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
A key defines a method response header and the value specifies whether the associated method response header is
required or not. The expression of the key must match the pattern method.response.header.{name}
,
where name
is a valid and unique header name. API Gateway passes certain integration response data
to the method response headers specified here according to the mapping you prescribe in the API's
IntegrationResponse. The integration response data that can be mapped include an integration response header
expressed in integration.response.header.{name}
, a static value enclosed within a pair of single
quotes (e.g., 'application/json'
), or a JSON expression from the back-end response payload in the
form of integration.response.body.{JSON-expression}
, where JSON-expression
is a valid
JSON expression without the $
prefix.)
method.response.header.{name}
, where name
is a valid and unique header name.
API Gateway passes certain integration response data to the method response headers specified here
according to the mapping you prescribe in the API's IntegrationResponse. The integration response data
that can be mapped include an integration response header expressed in
integration.response.header.{name}
, a static value enclosed within a pair of single quotes
(e.g., 'application/json'
), or a JSON expression from the back-end response payload in the
form of integration.response.body.{JSON-expression}
, where JSON-expression
is a
valid JSON expression without the $
prefix.)public void setResponseParameters(Map<String,Boolean> responseParameters)
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
A key defines a method response header and the value specifies whether the associated method response header is
required or not. The expression of the key must match the pattern method.response.header.{name}
,
where name
is a valid and unique header name. API Gateway passes certain integration response data
to the method response headers specified here according to the mapping you prescribe in the API's
IntegrationResponse. The integration response data that can be mapped include an integration response header
expressed in integration.response.header.{name}
, a static value enclosed within a pair of single
quotes (e.g., 'application/json'
), or a JSON expression from the back-end response payload in the
form of integration.response.body.{JSON-expression}
, where JSON-expression
is a valid
JSON expression without the $
prefix.)
responseParameters
- A key-value map specifying required or optional response parameters that API Gateway can send back to the
caller. A key defines a method response header and the value specifies whether the associated method
response header is required or not. The expression of the key must match the pattern
method.response.header.{name}
, where name
is a valid and unique header name. API
Gateway passes certain integration response data to the method response headers specified here according
to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be
mapped include an integration response header expressed in integration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g., 'application/json'
), or a
JSON expression from the back-end response payload in the form of
integration.response.body.{JSON-expression}
, where JSON-expression
is a valid
JSON expression without the $
prefix.)public UpdateMethodResponseResult withResponseParameters(Map<String,Boolean> responseParameters)
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
A key defines a method response header and the value specifies whether the associated method response header is
required or not. The expression of the key must match the pattern method.response.header.{name}
,
where name
is a valid and unique header name. API Gateway passes certain integration response data
to the method response headers specified here according to the mapping you prescribe in the API's
IntegrationResponse. The integration response data that can be mapped include an integration response header
expressed in integration.response.header.{name}
, a static value enclosed within a pair of single
quotes (e.g., 'application/json'
), or a JSON expression from the back-end response payload in the
form of integration.response.body.{JSON-expression}
, where JSON-expression
is a valid
JSON expression without the $
prefix.)
responseParameters
- A key-value map specifying required or optional response parameters that API Gateway can send back to the
caller. A key defines a method response header and the value specifies whether the associated method
response header is required or not. The expression of the key must match the pattern
method.response.header.{name}
, where name
is a valid and unique header name. API
Gateway passes certain integration response data to the method response headers specified here according
to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be
mapped include an integration response header expressed in integration.response.header.{name}
, a static value enclosed within a pair of single quotes (e.g., 'application/json'
), or a
JSON expression from the back-end response payload in the form of
integration.response.body.{JSON-expression}
, where JSON-expression
is a valid
JSON expression without the $
prefix.)public UpdateMethodResponseResult addResponseParametersEntry(String key, Boolean value)
public UpdateMethodResponseResult clearResponseParametersEntries()
public Map<String,String> getResponseModels()
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.
public void setResponseModels(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.
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.public UpdateMethodResponseResult 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.
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.public UpdateMethodResponseResult addResponseModelsEntry(String key, String value)
public UpdateMethodResponseResult clearResponseModelsEntries()
public String toString()
toString
in class Object
Object.toString()
public UpdateMethodResponseResult clone()