@Generated(value="software.amazon.awssdk:codegen") public final class UpdateMethodResponseResponse extends ApiGatewayResponse implements ToCopyableBuilder<UpdateMethodResponseResponse.Builder,UpdateMethodResponseResponse>
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": "https://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 |
UpdateMethodResponseResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static UpdateMethodResponseResponse.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasResponseModels()
Returns true if the ResponseModels property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasResponseParameters()
Returns true if the ResponseParameters property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
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 API Gateway can send back to the caller.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateMethodResponseResponse.Builder> |
serializableBuilderClass() |
String |
statusCode()
The method response's status code.
|
UpdateMethodResponseResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String statusCode()
The method response's status code.
public final boolean hasResponseParameters()
public final 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.)
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasResponseParameters() to see if a value was sent in this field.
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 final boolean hasResponseModels()
public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasResponseModels() to see if a value was sent in this field.
public UpdateMethodResponseResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<UpdateMethodResponseResponse.Builder,UpdateMethodResponseResponse>toBuilder in class AwsResponsepublic static UpdateMethodResponseResponse.Builder builder()
public static Class<? extends UpdateMethodResponseResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2021. All rights reserved.