com.amazonaws.services.apigateway.model

Class PutMethodResponseResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.apigateway.model.PutMethodResponseResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutMethodResponseResult
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.

Example: A MethodResponse instance of an API

Request

The example request retrieves a MethodResponse of the 200 status code.

 GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
 

Response

The successful response returns 200 OK status and a payload as follows:

 { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }
 

Method, IntegrationResponse, Integration Creating an API

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PutMethodResponseResult()

Method Summary

Modifier and Type	Method and Description
PutMethodResponseResult	addResponseModelsEntry(String key, String value)
PutMethodResponseResult	addResponseParametersEntry(String key, Boolean value)
PutMethodResponseResult	clearResponseModelsEntries() Removes all the entries added into ResponseModels.
PutMethodResponseResult	clearResponseParametersEntries() Removes all the entries added into ResponseParameters.
PutMethodResponseResult	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 Amazon 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 Amazon 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; useful for testing and debugging.
PutMethodResponseResult	withResponseModels(Map<String,String> responseModels) Specifies the Model resources used for the response's content-type.
PutMethodResponseResult	withResponseParameters(Map<String,Boolean> responseParameters) A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the caller.
PutMethodResponseResult	withStatusCode(String statusCode) The method response's status code.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutMethodResponseResult

public PutMethodResponseResult()

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 PutMethodResponseResult 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()

A key-value map specifying required or optional response parameters that Amazon 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. Amazon 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.)

Returns:

A key-value map specifying required or optional response parameters that Amazon 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. Amazon 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.)

setResponseParameters

public void setResponseParameters(Map<String,Boolean> responseParameters)

A key-value map specifying required or optional response parameters that Amazon 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. Amazon 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.)

Parameters:

responseParameters - A key-value map specifying required or optional response parameters that Amazon 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. Amazon 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.)

withResponseParameters

public PutMethodResponseResult withResponseParameters(Map<String,Boolean> responseParameters)

A key-value map specifying required or optional response parameters that Amazon 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. Amazon 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.)

Parameters:

responseParameters - A key-value map specifying required or optional response parameters that Amazon 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. Amazon 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.)

Returns:

Returns a reference to this object so that method calls can be chained together.

addResponseParametersEntry

public PutMethodResponseResult addResponseParametersEntry(String key,
                                                          Boolean value)

clearResponseParametersEntries

public PutMethodResponseResult clearResponseParametersEntries()

Removes all the entries added into ResponseParameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

getResponseModels

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.

Returns:

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.

setResponseModels

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.

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.

withResponseModels

public PutMethodResponseResult 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 PutMethodResponseResult addResponseModelsEntry(String key,
                                                      String value)

clearResponseModelsEntries

public PutMethodResponseResult clearResponseModelsEntries()

Removes all the entries added into ResponseModels.

Returns:

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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutMethodResponseResult clone()

Overrides:

clone in class Object