PutGatewayResponseRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest
    - - software.amazon.awssdk.services.apigateway.model.PutGatewayResponseRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutGatewayResponseRequest.Builder,PutGatewayResponseRequest>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class PutGatewayResponseRequest
extends ApiGatewayRequest
implements ToCopyableBuilder<PutGatewayResponseRequest.Builder,PutGatewayResponseRequest>
```
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutGatewayResponseRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PutGatewayResponseRequest.Builder`	`builder()`
`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 `SdkRequest`.
`int`	`hashCode()`
`Map<String,String>`	`responseParameters()`
`Map<String,String>`	`responseTemplates()`
`GatewayResponseType`	`responseType()` [Required]
`String`	`responseTypeAsString()` [Required]
`String`	`restApiId()` [Required] The string identifier of the associated RestApi.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutGatewayResponseRequest.Builder>`	`serializableBuilderClass()`
`String`	`statusCode()` The HTTP status code of the GatewayResponse.
`PutGatewayResponseRequest.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.awscore.AwsRequest
overrideConfiguration

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
  - restApiId
```
public String restApiId()
```
    [Required] The string identifier of the associated RestApi.
    
    Returns:
    
    [Required] The string identifier of the associated RestApi.
  - responseType
```
public GatewayResponseType responseType()
```
    [Required]
    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_TYPE
    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:
    [Required]
    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_TYPE
    See Also:
    
    GatewayResponseType
  - responseTypeAsString
```
public String responseTypeAsString()
```
    [Required]
    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_TYPE
    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:
    [Required]
    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_TYPE
    See Also:
    
    GatewayResponseType
  - statusCode
```
public String statusCode()
```
    The HTTP status code of the GatewayResponse.
    
    Returns:
    
    The HTTP status code of the 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.
  - toBuilder
```
public PutGatewayResponseRequest.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<PutGatewayResponseRequest.Builder,PutGatewayResponseRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static PutGatewayResponseRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutGatewayResponseRequest.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: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    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
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class PutGatewayResponseRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

restApiId

responseType

responseTypeAsString

statusCode

responseParameters

responseTemplates

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields