All Implemented Interfaces:


public final class RequestPayload

Kuzzle Request Payload

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`controller`
`private String`	`action`
`private String`	`index`
`private String`	`collection`
`private String`	`_id`
`private String`	`jwt`
`private Object`	`volatile`
`private Object`	`body`
`private String`	`requestId`
`private Map<String, Object>`	`other`
`private Map<String, Object>`	`headers`

Constructor Summary

Constructors
Constructor	Description
`RequestPayload(String controller, String action, String index, String collection, String _id, String jwt, Object volatile, Object body, String requestId, Map<String, Object> other, Map<String, Object> headers)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getController()`	API controller name
`final Unit`	`setController(String controller)`	API controller name
`final String`	`getAction()`	API action name
`final Unit`	`setAction(String action)`	API action name
`final String`	`getIndex()`	Index name
`final Unit`	`setIndex(String index)`	Index name
`final String`	`getCollection()`	Collection name
`final Unit`	`setCollection(String collection)`	Collection name
`final String`	`get_id()`	Document unique identifier
`final Unit`	`set_id(String _id)`	Document unique identifier
`final String`	`getJwt()`	Authentication token
`final Unit`	`setJwt(String jwt)`	Authentication token
`final Object`	`getVolatile()`	Volatile data
`final Unit`	`setVolatile(Object volatile)`	Volatile data
`final Object`	`getBody()`	Request body
`final Unit`	`setBody(Object body)`	Request body
`final String`	`getRequestId()`	Request unique identifier
`final Unit`	`setRequestId(String requestId)`	Request unique identifier
`final Map<String, Object>`	`getOther()`	Other parameters not present in RequestPayload
`final Unit`	`setOther(Map<String, Object> other)`	Other parameters not present in RequestPayload
`final Map<String, Object>`	`getHeaders()`
`final Unit`	`setHeaders(Map<String, Object> headers)`
`final Map<String, Object>`	`toMap()`

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

Constructor Detail

RequestPayload

RequestPayload(String controller, String action, String index, String collection, String _id, String jwt, Object volatile, Object body, String requestId, Map<String, Object> other, Map<String, Object> headers)

Method Detail

getController
```
 final String getController()
```
API controller name

setController

 final Unit setController(String controller)

API controller name

getAction
```
 final String getAction()
```
API action name

setAction
```
 final Unit setAction(String action)
```
API action name

getIndex
```
 final String getIndex()
```
Index name

setIndex
```
 final Unit setIndex(String index)
```
Index name

getCollection
```
 final String getCollection()
```
Collection name

setCollection

 final Unit setCollection(String collection)

Collection name

get_id
```
 final String get_id()
```
Document unique identifier

set_id
```
 final Unit set_id(String _id)
```
Document unique identifier

getJwt
```
 final String getJwt()
```
Authentication token

setJwt
```
 final Unit setJwt(String jwt)
```
Authentication token

getVolatile
```
 final Object getVolatile()
```
Volatile data

setVolatile

 final Unit setVolatile(Object volatile)

Volatile data

getBody
```
 final Object getBody()
```
Request body

setBody
```
 final Unit setBody(Object body)
```
Request body

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

setRequestId

 final Unit setRequestId(String requestId)

Request unique identifier

getOther
```
 final Map<String, Object> getOther()
```
Other parameters not present in RequestPayload

setOther
```
 final Unit setOther(Map<String, Object> other)
```
Other parameters not present in RequestPayload

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

setHeaders

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

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

Class RequestPayload

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestPayload

Method Detail

getController

setController

getAction

setAction

getIndex

setIndex

getCollection

setCollection

get_id

set_id

getJwt

setJwt

getVolatile

setVolatile

getBody

setBody

getRequestId

setRequestId

getOther

setOther

getHeaders

setHeaders

toMap