All Implemented Interfaces:: io.kuzzle.sdk.coreClasses.maps.Serializable


public final class Response
 implements Serializable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final KuzzleMap`	`mapResponse`
`private String`	`room`
`private Object`	`result`
`private ErrorResponse`	`error`
`private String`	`requestId`
`private Integer`	`status`
`private String`	`controller`
`private String`	`action`
`private String`	`index`
`private String`	`collection`
`private Map<String, Object>`	`Volatile`
`private String`	`protocol`
`private String`	`scope`
`private String`	`state`
`private Long`	`timestamp`
`private String`	`type`
`private Map<String, Object>`	`headers`

Constructor Summary

Constructors
Constructor	Description
`Response()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final KuzzleMap`	`getMapResponse()`
`final String`	`getRoom()`
`final Unit`	`setRoom(String room)`
`final Object`	`getResult()`	Response payload (depends on the executed API action)
`final Unit`	`setResult(Object result)`	Response payload (depends on the executed API action)
`final ErrorResponse`	`getError()`	Error object (null if the request finished successfully)
`final Unit`	`setError(ErrorResponse error)`	Error object (null if the request finished successfully)
`final String`	`getRequestId()`	Request unique identifier.
`final Unit`	`setRequestId(String requestId)`	Request unique identifier.
`final Integer`	`getStatus()`	Response status, following HTTP status codes
`final Unit`	`setStatus(Integer status)`	Response status, following HTTP status codes
`final String`	`getController()`	Executed Kuzzle API controller
`final Unit`	`setController(String controller)`	Executed Kuzzle API controller
`final String`	`getAction()`	Executed Kuzzle API controller's action.
`final Unit`	`setAction(String action)`	Executed Kuzzle API controller's action.
`final String`	`getIndex()`	Impacted data index.
`final Unit`	`setIndex(String index)`	Impacted data index.
`final String`	`getCollection()`	Impacted data collection.
`final Unit`	`setCollection(String collection)`	Impacted data collection.
`final Map<String, Object>`	`getVolatile()`	Volatile data.
`final Unit`	`setVolatile(Map<String, Object> Volatile)`	Volatile data.
`final String`	`getProtocol()`	Network protocol at the origin of the real-time notification.
`final Unit`	`setProtocol(String protocol)`	Network protocol at the origin of the real-time notification.
`final String`	`getScope()`	Document scope ("in" or "out")
`final Unit`	`setScope(String scope)`	Document scope ("in" or "out")
`final String`	`getState()`	Document state
`final Unit`	`setState(String state)`	Document state
`final Long`	`getTimestamp()`	Notification timestamp (UTC)
`final Unit`	`setTimestamp(Long timestamp)`	Notification timestamp (UTC)
`final String`	`getType()`	Notification type
`final Unit`	`setType(String type)`	Notification type
`final Map<String, Object>`	`getHeaders()`	Response headers
`final Unit`	`setHeaders(Map<String, Object> headers)`	Response headers
`Unit`	`fromMap(Map<String, Object> map)`
`Map<String, Object>`	`toMap()`
`String`	`toString()`

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

Constructor Detail
- Response
```
Response()
```

Method Detail

getMapResponse
```
 final KuzzleMap getMapResponse()
```

getRoom
```
 final String getRoom()
```

setRoom
```
 final Unit setRoom(String room)
```

getResult
```
 final Object getResult()
```
Response payload (depends on the executed API action)

setResult
```
 final Unit setResult(Object result)
```
Response payload (depends on the executed API action)

getError
```
 final ErrorResponse getError()
```
Error object (null if the request finished successfully)

setError
```
 final Unit setError(ErrorResponse error)
```
Error object (null if the request finished successfully)

getRequestId
```
 final String getRequestId()
```
Request unique identifier.

setRequestId

 final Unit setRequestId(String requestId)

Request unique identifier.

getStatus
```
 final Integer getStatus()
```
Response status, following HTTP status codes

setStatus
```
 final Unit setStatus(Integer status)
```
Response status, following HTTP status codes

getController
```
 final String getController()
```
Executed Kuzzle API controller

setController

 final Unit setController(String controller)

Executed Kuzzle API controller

getAction
```
 final String getAction()
```
Executed Kuzzle API controller's action.

setAction
```
 final Unit setAction(String action)
```
Executed Kuzzle API controller's action.

getIndex
```
 final String getIndex()
```
Impacted data index.

setIndex
```
 final Unit setIndex(String index)
```
Impacted data index.

getCollection
```
 final String getCollection()
```
Impacted data collection.

setCollection

 final Unit setCollection(String collection)

Impacted data collection.

getVolatile

 final Map<String, Object> getVolatile()

Volatile data.

setVolatile

 final Unit setVolatile(Map<String, Object> Volatile)

Volatile data.

getProtocol
```
 final String getProtocol()
```
Network protocol at the origin of the real-time notification.

setProtocol
```
 final Unit setProtocol(String protocol)
```
Network protocol at the origin of the real-time notification.

getScope
```
 final String getScope()
```
Document scope ("in" or "out")

setScope
```
 final Unit setScope(String scope)
```
Document scope ("in" or "out")

getState
```
 final String getState()
```
Document state

setState
```
 final Unit setState(String state)
```
Document state

getTimestamp
```
 final Long getTimestamp()
```
Notification timestamp (UTC)

setTimestamp

 final Unit setTimestamp(Long timestamp)

Notification timestamp (UTC)

getType
```
 final String getType()
```
Notification type

setType
```
 final Unit setType(String type)
```
Notification type

getHeaders
```
 final Map<String, Object> getHeaders()
```
Response headers

setHeaders

 final Unit setHeaders(Map<String, Object> headers)

Response headers

fromMap
```
 Unit fromMap(Map<String, Object> map)
```

toMap
```
 Map<String, Object> toMap()
```

toString
```
 String toString()
```

Class Response

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Response

Method Detail

getMapResponse

getRoom

setRoom

getResult

setResult

getError

setError

getRequestId

setRequestId

getStatus

setStatus

getController

setController

getAction

setAction

getIndex

setIndex

getCollection

setCollection

getVolatile

setVolatile

getProtocol

setProtocol

getScope

setScope

getState

setState

getTimestamp

setTimestamp

getType

setType

getHeaders

setHeaders

fromMap

toMap

toString