@Generated(value="software.amazon.awssdk:codegen") public final class GetMethodResponseResponse extends ApiGatewayResponse implements ToCopyableBuilder<GetMethodResponseResponse.Builder,GetMethodResponseResponse>
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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetMethodResponseResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetMethodResponseResponse.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasResponseModels()
For responses, this returns true if the service returned a value for the ResponseModels property.
|
boolean |
hasResponseParameters()
For responses, this returns true if the service returned a value for the ResponseParameters property.
|
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 GetMethodResponseResponse.Builder> |
serializableBuilderClass() |
String |
statusCode()
The method response's status code.
|
GetMethodResponseResponse.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()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasResponseParameters() method.
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()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasResponseModels() method.
public GetMethodResponseResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<GetMethodResponseResponse.Builder,GetMethodResponseResponse>toBuilder in class AwsResponsepublic static GetMethodResponseResponse.Builder builder()
public static Class<? extends GetMethodResponseResponse.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 © 2023. All rights reserved.