UpdateGatewayResponseResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
    - - software.amazon.awssdk.services.apigateway.model.UpdateGatewayResponseResponse

All Implemented Interfaces:: ToCopyableBuilder<UpdateGatewayResponseResponse.Builder,UpdateGatewayResponseResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateGatewayResponseResponse
extends ApiGatewayResponse
implements ToCopyableBuilder<UpdateGatewayResponseResponse.Builder,UpdateGatewayResponseResponse>

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

For more information about valid gateway response types, see Gateway Response Types Supported by Amazon API Gateway

Example: Get a Gateway Response of a given response type

Request

This example shows how to get a gateway response of the MISSING_AUTHNETICATION_TOKEN type.

 GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45

The response type is specified as a URL path.

Response

The successful operation returns the 200 OK status code and a payload similar to the following:

 { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{\n \"message\": $context.error.messageString,\n \"type\": \"$context.error.responseType\",\n \"stage\": \"$context.stage\",\n \"resourcePath\": \"$context.resourcePath\",\n \"stageVariables.a\": \"$stageVariables.a\",\n \"statusCode\": \"'404'\"\n}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN", "statusCode": "404" }

Customize Gateway Responses

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateGatewayResponseResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateGatewayResponseResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateGatewayResponseResponse.Builder`	`builder()`
`Boolean`	`defaultResponse()` A Boolean flag to indicate whether this GatewayResponse is the default gateway response (`true` ) or not (`false`).
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`Map<String,String>`	`responseParameters()` Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
`Map<String,String>`	`responseTemplates()` Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
`GatewayResponseType`	`responseType()` The response type of the associated GatewayResponse.
`String`	`responseTypeAsString()` The response type of the associated GatewayResponse.
`static Class<? extends UpdateGatewayResponseResponse.Builder>`	`serializableBuilderClass()`
`String`	`statusCode()` The HTTP status code for this GatewayResponse.
`UpdateGatewayResponseResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - responseType
```
public GatewayResponseType responseType()
```
    The response type of the associated GatewayResponse. Valid values are
    - ACCESS_DENIED
    - API_CONFIGURATION_ERROR
    - AUTHORIZER_FAILURE
    - AUTHORIZER_CONFIGURATION_ERROR
    - BAD_REQUEST_PARAMETERS
    - BAD_REQUEST_BODY
    - DEFAULT_4XX
    - DEFAULT_5XX
    - EXPIRED_TOKEN
    - INVALID_SIGNATURE
    - INTEGRATION_FAILURE
    - INTEGRATION_TIMEOUT
    - INVALID_API_KEY
    - MISSING_AUTHENTICATION_TOKEN
    - QUOTA_EXCEEDED
    - REQUEST_TOO_LARGE
    - RESOURCE_NOT_FOUND
    - THROTTLED
    - UNAUTHORIZED
    - UNSUPPORTED_MEDIA_TYPES
    If the service returns an enum value that is not available in the current SDK version, responseType will return GatewayResponseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from responseTypeAsString().
    Returns:
    The response type of the associated GatewayResponse. Valid values are
    
    ACCESS_DENIED
    
    API_CONFIGURATION_ERROR
    
    AUTHORIZER_FAILURE
    
    AUTHORIZER_CONFIGURATION_ERROR
    
    BAD_REQUEST_PARAMETERS
    
    BAD_REQUEST_BODY
    
    DEFAULT_4XX
    
    DEFAULT_5XX
    
    EXPIRED_TOKEN
    
    INVALID_SIGNATURE
    
    INTEGRATION_FAILURE
    
    INTEGRATION_TIMEOUT
    
    INVALID_API_KEY
    
    MISSING_AUTHENTICATION_TOKEN
    
    QUOTA_EXCEEDED
    
    REQUEST_TOO_LARGE
    
    RESOURCE_NOT_FOUND
    
    THROTTLED
    
    UNAUTHORIZED
    
    UNSUPPORTED_MEDIA_TYPES
    See Also:
    
    GatewayResponseType
  - responseTypeAsString
```
public String responseTypeAsString()
```
    The response type of the associated GatewayResponse. Valid values are
    - ACCESS_DENIED
    - API_CONFIGURATION_ERROR
    - AUTHORIZER_FAILURE
    - AUTHORIZER_CONFIGURATION_ERROR
    - BAD_REQUEST_PARAMETERS
    - BAD_REQUEST_BODY
    - DEFAULT_4XX
    - DEFAULT_5XX
    - EXPIRED_TOKEN
    - INVALID_SIGNATURE
    - INTEGRATION_FAILURE
    - INTEGRATION_TIMEOUT
    - INVALID_API_KEY
    - MISSING_AUTHENTICATION_TOKEN
    - QUOTA_EXCEEDED
    - REQUEST_TOO_LARGE
    - RESOURCE_NOT_FOUND
    - THROTTLED
    - UNAUTHORIZED
    - UNSUPPORTED_MEDIA_TYPES
    If the service returns an enum value that is not available in the current SDK version, responseType will return GatewayResponseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from responseTypeAsString().
    Returns:
    The response type of the associated GatewayResponse. Valid values are
    
    ACCESS_DENIED
    
    API_CONFIGURATION_ERROR
    
    AUTHORIZER_FAILURE
    
    AUTHORIZER_CONFIGURATION_ERROR
    
    BAD_REQUEST_PARAMETERS
    
    BAD_REQUEST_BODY
    
    DEFAULT_4XX
    
    DEFAULT_5XX
    
    EXPIRED_TOKEN
    
    INVALID_SIGNATURE
    
    INTEGRATION_FAILURE
    
    INTEGRATION_TIMEOUT
    
    INVALID_API_KEY
    
    MISSING_AUTHENTICATION_TOKEN
    
    QUOTA_EXCEEDED
    
    REQUEST_TOO_LARGE
    
    RESOURCE_NOT_FOUND
    
    THROTTLED
    
    UNAUTHORIZED
    
    UNSUPPORTED_MEDIA_TYPES
    See Also:
    
    GatewayResponseType
  - statusCode
```
public String statusCode()
```
    The HTTP status code for this GatewayResponse.
    
    Returns:
    
    The HTTP status code for this GatewayResponse.
  - responseParameters
```
public Map<String,String> responseParameters()
```
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
  - responseTemplates
```
public Map<String,String> responseTemplates()
```
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
  - defaultResponse
```
public Boolean defaultResponse()
```
    A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true ) or not (false). A default gateway response is one generated by Amazon API Gateway without any customization by an API developer.
    
    Returns:
    
    A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( true) or not (false). A default gateway response is one generated by Amazon API Gateway without any customization by an API developer.
  - toBuilder
```
public UpdateGatewayResponseResponse.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateGatewayResponseResponse.Builder,UpdateGatewayResponseResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static UpdateGatewayResponseResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateGatewayResponseResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value

Class UpdateGatewayResponseResponse

Example: Get a Gateway Response of a given response type

Request

Response

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

responseType

responseTypeAsString

statusCode

responseParameters

responseTemplates

defaultResponse

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField