@Generated(value="software.amazon.awssdk:codegen") public final class MethodResponse extends Object implements StructuredPojo, ToCopyableBuilder<MethodResponse.Builder,MethodResponse>
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.
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}
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" }
Modifier and Type | Class and Description |
---|---|
static interface |
MethodResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static MethodResponse.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Map<String,String> |
responseModels()
Specifies the Model resources used for the response's content-type.
|
Map<String,Boolean> |
responseParameters()
A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the
caller.
|
static Class<? extends MethodResponse.Builder> |
serializableBuilderClass() |
String |
statusCode()
The method response's status code.
|
MethodResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String statusCode()
The method response's status code.
public 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.)
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.)public MethodResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<MethodResponse.Builder,MethodResponse>
public static MethodResponse.Builder builder()
public static Class<? extends MethodResponse.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.