PutGatewayResponseRequest (AWS Java SDK :: Services :: Amazon API Gateway 2.16.76 API)

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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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).
`boolean`	`hasResponseTemplates()` Returns true if the ResponseTemplates 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>`	`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()`
`String`	`toString()` Returns a string representation of this object.

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

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

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

- Method Detail
  - restApiId
```
public final String restApiId()
```
    [Required] The string identifier of the associated RestApi.
    
    Returns:
    
    [Required] The string identifier of the associated RestApi.
  - responseType
```
public final 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 final 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 final String statusCode()
```
    The HTTP status code of the GatewayResponse.
    
    Returns:
    
    The HTTP status code of the GatewayResponse.
  - hasResponseParameters
```
public final 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). For responses returned by the SDK, the sender is the AWS service.
  - responseParameters
```
public final 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.
    
    You can use hasResponseParameters() to see if a value was sent in this field.
    
    Returns:
    
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
  - hasResponseTemplates
```
public final boolean hasResponseTemplates()
```
    Returns true if the ResponseTemplates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - responseTemplates
```
public final 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.
    
    You can use hasResponseTemplates() to see if a value was sent in this field.
    
    Returns:
    
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
  - toBuilder
```
public PutGatewayResponseRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutGatewayResponseRequest.Builder,PutGatewayResponseRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayRequest
  - builder
```
public static PutGatewayResponseRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutGatewayResponseRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

hasResponseParameters

responseParameters

hasResponseTemplates

responseTemplates

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields