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("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 Description

static interface PutGatewayResponseRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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()`	For responses, this returns true if the service returned a value for the ResponseParameters property.
`boolean`	`hasResponseTemplates()`	For responses, this returns true if the service returned a value for the ResponseTemplates property.
`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
`String`	`restApiId()`	The string identifier of the associated RestApi.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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()
```
    The string identifier of the associated RestApi.
    
    Returns:
    
    The string identifier of the associated RestApi.
  - responseType
```
public final GatewayResponseType responseType()
```
    The response type of the associated GatewayResponse
    
    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
    
    See Also:
    
    GatewayResponseType
  - responseTypeAsString
```
public final String responseTypeAsString()
```
    The response type of the associated GatewayResponse
    
    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
    
    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()
```
    For responses, this returns true if the service returned a value for the ResponseParameters property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - 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.
    
    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.
    
    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()
```
    For responses, this returns true if the service returned a value for the ResponseTemplates property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - 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.
    
    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 hasResponseTemplates() method.
    
    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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField 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

sdkFieldNameToField