GatewayResponse (AWS Java SDK for Amazon API Gateway 1.12.422 API)

java.lang.Object
- com.amazonaws.services.apigateway.model.GatewayResponse

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GatewayResponse
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A gateway response of a given response type and status code, with optional response parameters and mapping templates.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GatewayResponse()

Constructors
Constructor and Description
`GatewayResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GatewayResponse`	`addResponseParametersEntry(String key, String value)` Add a single ResponseParameters entry
`GatewayResponse`	`addResponseTemplatesEntry(String key, String value)` Add a single ResponseTemplates entry
`GatewayResponse`	`clearResponseParametersEntries()` Removes all the entries added into ResponseParameters.
`GatewayResponse`	`clearResponseTemplatesEntries()` Removes all the entries added into ResponseTemplates.
`GatewayResponse`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getDefaultResponse()` A Boolean flag to indicate whether this GatewayResponse is the default gateway response (`true`) or not (`false`).
`Map<String,String>`	`getResponseParameters()` Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
`Map<String,String>`	`getResponseTemplates()` Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
`String`	`getResponseType()` The response type of the associated GatewayResponse.
`String`	`getStatusCode()` The HTTP status code for this GatewayResponse.
`int`	`hashCode()`
`Boolean`	`isDefaultResponse()` A Boolean flag to indicate whether this GatewayResponse is the default gateway response (`true`) or not (`false`).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setDefaultResponse(Boolean defaultResponse)` A Boolean flag to indicate whether this GatewayResponse is the default gateway response (`true`) or not (`false`).
`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.
`void`	`setResponseTemplates(Map<String,String> responseTemplates)` Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
`void`	`setResponseType(GatewayResponseType responseType)` The response type of the associated GatewayResponse.
`void`	`setResponseType(String responseType)` The response type of the associated GatewayResponse.
`void`	`setStatusCode(String statusCode)` The HTTP status code for this GatewayResponse.
`String`	`toString()` Returns a string representation of this object.
`GatewayResponse`	`withDefaultResponse(Boolean defaultResponse)` A Boolean flag to indicate whether this GatewayResponse is the default gateway response (`true`) or not (`false`).
`GatewayResponse`	`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.
`GatewayResponse`	`withResponseTemplates(Map<String,String> responseTemplates)` Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
`GatewayResponse`	`withResponseType(GatewayResponseType responseType)` The response type of the associated GatewayResponse.
`GatewayResponse`	`withResponseType(String responseType)` The response type of the associated GatewayResponse.
`GatewayResponse`	`withStatusCode(String statusCode)` The HTTP status code for this GatewayResponse.

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

- Constructor Detail
  - GatewayResponse
```
public GatewayResponse()
```
- Method Detail
  - setResponseType
```
public void setResponseType(String responseType)
```
    The response type of the associated GatewayResponse.
    
    Parameters:
    
    responseType - The response type of the associated GatewayResponse.
    
    See Also:
    
    GatewayResponseType
  - getResponseType
```
public String getResponseType()
```
    The response type of the associated GatewayResponse.
    
    Returns:
    
    The response type of the associated GatewayResponse.
    
    See Also:
    
    GatewayResponseType
  - withResponseType
```
public GatewayResponse withResponseType(String responseType)
```
    The response type of the associated GatewayResponse.
    
    Parameters:
    
    responseType - The response type of the associated GatewayResponse.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GatewayResponseType
  - setResponseType
```
public void setResponseType(GatewayResponseType responseType)
```
    The response type of the associated GatewayResponse.
    
    Parameters:
    
    responseType - The response type of the associated GatewayResponse.
    
    See Also:
    
    GatewayResponseType
  - withResponseType
```
public GatewayResponse withResponseType(GatewayResponseType responseType)
```
    The response type of the associated GatewayResponse.
    
    Parameters:
    
    responseType - The response type of the associated GatewayResponse.
    
    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 for this GatewayResponse.
    
    Parameters:
    
    statusCode - The HTTP status code for this GatewayResponse.
  - getStatusCode
```
public String getStatusCode()
```
    The HTTP status code for this GatewayResponse.
    
    Returns:
    
    The HTTP status code for this GatewayResponse.
  - withStatusCode
```
public GatewayResponse withStatusCode(String statusCode)
```
    The HTTP status code for this GatewayResponse.
    
    Parameters:
    
    statusCode - The HTTP status code for this 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 GatewayResponse 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 GatewayResponse addResponseParametersEntry(String key,
                                                  String value)
```
    Add a single ResponseParameters entry
    
    See Also:
    
    withResponseParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearResponseParametersEntries
```
public GatewayResponse 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 GatewayResponse 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 GatewayResponse addResponseTemplatesEntry(String key,
                                                 String value)
```
    Add a single ResponseTemplates entry
    
    See Also:
    
    withResponseTemplates(java.util.Map<java.lang.String, java.lang.String>)
  - clearResponseTemplatesEntries
```
public GatewayResponse clearResponseTemplatesEntries()
```
    Removes all the entries added into ResponseTemplates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultResponse
```
public void setDefaultResponse(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 API Gateway without any customization by an API developer.
    
    Parameters:
    
    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 API Gateway without any customization by an API developer.
  - getDefaultResponse
```
public Boolean getDefaultResponse()
```
    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 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 API Gateway without any customization by an API developer.
  - withDefaultResponse
```
public GatewayResponse withDefaultResponse(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 API Gateway without any customization by an API developer.
    
    Parameters:
    
    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 API Gateway without any customization by an API developer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDefaultResponse
```
public Boolean isDefaultResponse()
```
    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 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 API Gateway without any customization by an API developer.
  - 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 GatewayResponse clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class GatewayResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GatewayResponse

Method Detail

setResponseType

getResponseType

withResponseType

setResponseType

withResponseType

setStatusCode

getStatusCode

withStatusCode

getResponseParameters

setResponseParameters

withResponseParameters

addResponseParametersEntry

clearResponseParametersEntries

getResponseTemplates

setResponseTemplates

withResponseTemplates

addResponseTemplatesEntry

clearResponseTemplatesEntries

setDefaultResponse

getDefaultResponse

withDefaultResponse

isDefaultResponse

toString

equals

hashCode

clone

marshall