PutGatewayResponseRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.apigateway.model.PutGatewayResponseRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutGatewayResponseRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

PutGatewayResponseRequest()

Constructors
Constructor and Description
`PutGatewayResponseRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutGatewayResponseRequest`	`addResponseParametersEntry(String key, String value)`
`PutGatewayResponseRequest`	`addResponseTemplatesEntry(String key, String value)`
`PutGatewayResponseRequest`	`clearResponseParametersEntries()` Removes all the entries added into ResponseParameters.
`PutGatewayResponseRequest`	`clearResponseTemplatesEntries()` Removes all the entries added into ResponseTemplates.
`PutGatewayResponseRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getResponseParameters()`
`Map<String,String>`	`getResponseTemplates()`
`String`	`getResponseType()` [Required]
`String`	`getRestApiId()` [Required] The string identifier of the associated RestApi.
`String`	`getStatusCode()` The HTTP status code of the GatewayResponse.
`int`	`hashCode()`
`void`	`setResponseParameters(Map<String,String> responseParameters)`
`void`	`setResponseTemplates(Map<String,String> responseTemplates)`
`void`	`setResponseType(GatewayResponseType responseType)` [Required]
`void`	`setResponseType(String responseType)` [Required]
`void`	`setRestApiId(String restApiId)` [Required] The string identifier of the associated RestApi.
`void`	`setStatusCode(String statusCode)` The HTTP status code of the GatewayResponse.
`String`	`toString()` Returns a string representation of this object.
`PutGatewayResponseRequest`	`withResponseParameters(Map<String,String> responseParameters)`
`PutGatewayResponseRequest`	`withResponseTemplates(Map<String,String> responseTemplates)`
`PutGatewayResponseRequest`	`withResponseType(GatewayResponseType responseType)` [Required]
`PutGatewayResponseRequest`	`withResponseType(String responseType)` [Required]
`PutGatewayResponseRequest`	`withRestApiId(String restApiId)` [Required] The string identifier of the associated RestApi.
`PutGatewayResponseRequest`	`withStatusCode(String statusCode)` The HTTP status code of the GatewayResponse.

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

- Constructor Detail
  - PutGatewayResponseRequest
```
public PutGatewayResponseRequest()
```
- Method Detail
  - setRestApiId
```
public void setRestApiId(String restApiId)
```
    [Required] The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - [Required] The string identifier of the associated RestApi.
  - getRestApiId
```
public String getRestApiId()
```
    [Required] The string identifier of the associated RestApi.
    
    Returns:
    
    [Required] The string identifier of the associated RestApi.
  - withRestApiId
```
public PutGatewayResponseRequest withRestApiId(String restApiId)
```
    [Required] The string identifier of the associated RestApi.
    
    Parameters:
    
    restApiId - [Required] The string identifier of the associated RestApi.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResponseType
```
public void setResponseType(String 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
    Parameters:
    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
    See Also:
    
    GatewayResponseType
  - getResponseType
```
public String getResponseType()
```
    [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
    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
  - withResponseType
```
public PutGatewayResponseRequest withResponseType(String 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GatewayResponseType
  - setResponseType
```
public void setResponseType(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
    Parameters:
    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
    See Also:
    
    GatewayResponseType
  - withResponseType
```
public PutGatewayResponseRequest withResponseType(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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GatewayResponseType
  - setStatusCode
```
public void setStatusCode(String statusCode)
```
    The HTTP status code of the GatewayResponse.
    
    Parameters:
    
    statusCode - The HTTP status code of the GatewayResponse.
  - getStatusCode
```
public String getStatusCode()
```
    The HTTP status code of the GatewayResponse.
    
    Returns:
    
    The HTTP status code of the GatewayResponse.
  - withStatusCode
```
public PutGatewayResponseRequest withStatusCode(String statusCode)
```
    The HTTP status code of the GatewayResponse.
    
    Parameters:
    
    statusCode - The HTTP status code of the GatewayResponse.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResponseParameters
```
public Map<String,String> getResponseParameters()
```
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Returns:
    
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
  - setResponseParameters
```
public void setResponseParameters(Map<String,String> responseParameters)
```
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Parameters:
    
    responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
  - withResponseParameters
```
public PutGatewayResponseRequest withResponseParameters(Map<String,String> responseParameters)
```
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Parameters:
    
    responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addResponseParametersEntry
```
public PutGatewayResponseRequest addResponseParametersEntry(String key,
                                                            String value)
```
  - clearResponseParametersEntries
```
public PutGatewayResponseRequest clearResponseParametersEntries()
```
    Removes all the entries added into ResponseParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResponseTemplates
```
public Map<String,String> getResponseTemplates()
```
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Returns:
    
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
  - setResponseTemplates
```
public void setResponseTemplates(Map<String,String> responseTemplates)
```
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Parameters:
    
    responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
  - withResponseTemplates
```
public PutGatewayResponseRequest withResponseTemplates(Map<String,String> responseTemplates)
```
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Parameters:
    
    responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addResponseTemplatesEntry
```
public PutGatewayResponseRequest addResponseTemplatesEntry(String key,
                                                           String value)
```
  - clearResponseTemplatesEntries
```
public PutGatewayResponseRequest clearResponseTemplatesEntries()
```
    Removes all the entries added into ResponseTemplates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PutGatewayResponseRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class PutGatewayResponseRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutGatewayResponseRequest

Method Detail

setRestApiId

getRestApiId

withRestApiId

setResponseType

getResponseType

withResponseType

setResponseType

withResponseType

setStatusCode

getStatusCode

withStatusCode

getResponseParameters

setResponseParameters

withResponseParameters

addResponseParametersEntry

clearResponseParametersEntries

getResponseTemplates

setResponseTemplates

withResponseTemplates

addResponseTemplatesEntry

clearResponseTemplatesEntries

toString

equals

hashCode

clone