Response (Spotify Apollo Parent 1.0.3 API)

```
public interface Response<T>
```
Defines the data Apollo needs to construct and send a response to an incoming request. Response instances are immutable. However, headers can be added using withHeader(String, String). These will create new copies of the Response object.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static <T> Response<T>`	`forPayload(T payload)` Creates a 200 OK `Response` with the given payload of type `T` .
`static <T> Response<T>`	`forStatus(StatusType statusCode)` Creates a `Response` with the given status code.
`Map<String,String>`	`headers()` The response headers.
`static <T> Response<T>`	`of(StatusType statusCode, T payload)` Creates a `Response` with the given status code and a payload with type `T`.
`static <T> Response<T>`	`ok()` Returns a typed 200 OK `Response`.
`Optional<T>`	`payload()` The single payload of the response.
`StatusType`	`status()` The status of the response message.
`Response<T>`	`withHeader(String header, String value)` Creates a new `Response` based on this, but with an additional header.
`Response<T>`	`withHeaders(Map<String,String> headers)` Creates a new `Response` based on this, but with additional headers.
`<P> Response<P>`	`withPayload(P newPayload)` Creates a new `Response` based on this, but with a different payload.

- Method Detail
  - status
```
StatusType status()
```
    The status of the response message.
  - headers
```
Map<String,String> headers()
```
    The response headers.
  - payload
```
Optional<T> payload()
```
    The single payload of the response.
  - withHeader
```
Response<T> withHeader(String header,
                       String value)
```
    Creates a new Response based on this, but with an additional header.
    
    Parameters:
    
    header - Header name to add
    
    value - Header value
    
    Returns:
    
    A response with the added header
  - withHeaders
```
Response<T> withHeaders(Map<String,String> headers)
```
    Creates a new Response based on this, but with additional headers.
    
    Parameters:
    
    headers - Map of header name-values to add
    
    Returns:
    
    A response with the added headers
  - withPayload
```
<P> Response<P> withPayload(@Nullable
                            P newPayload)
```
    Creates a new Response based on this, but with a different payload. Status code, headers, etc., are copied over. To clear out the payload, one can pass in null.
    
    Parameters:
    
    newPayload - the new payload
  - ok
```
static <T> Response<T> ok()
```
    Returns a typed 200 OK Response.
    
    Type Parameters:
    
    T - The response payload type
    
    Returns:
    
    A response object
  - forStatus
```
static <T> Response<T> forStatus(StatusType statusCode)
```
    Creates a Response with the given status code. If code is OK, this function will be equivalent to ok().
    
    Type Parameters:
    
    T - The response payload type
    
    Parameters:
    
    statusCode - The status code
    
    Returns:
    
    A response object with the given status code
  - forPayload
```
static <T> Response<T> forPayload(T payload)
```
    Creates a 200 OK Response with the given payload of type T .
    
    Type Parameters:
    
    T - The response payload type
    
    Parameters:
    
    payload - The payload to respond with
    
    Returns:
    
    A response object with the given payload
  - of
```
static <T> Response<T> of(StatusType statusCode,
                          T payload)
```
    Creates a Response with the given status code and a payload with type T.
    
    Type Parameters:
    
    T - The response payload type
    
    Parameters:
    
    statusCode - The status code
    
    payload - The payload to respond with
    
    Returns:
    
    A response object with the given status code and payload

Interface Response<T>

Method Summary

Method Detail

status

headers

payload

withHeader

withHeaders

withPayload

ok

forStatus

forPayload

of