KuzzleRequest #
KuzzleRequest
is a serializable class representing a raw Kuzzle request.
Properties #
Property | Type | Description |
---|---|---|
action | String | Executed Kuzzle API controller's action ` |
body | Map<String, dynamic> body | |
collection | String | Impacted collection |
controller | String | Executed Kuzzle API controller |
index | String | Impacted index |
jwt | String | Authentication token |
lang | String | ES lang |
requestId | String | Request unique identifier |
waitForRefresh | bool | If set to true , Kuzzle will wait for the persistence layer to finish indexing |
volatile | Map<String, dynamic> | Volatile data |
from | int ( 0 ) | Offset of the first document to fetch |
size | int ( 10 ) | Maximum number of documents to retrieve per page |
scroll | String ( "" ) | When set, gets a forward-only cursor having its ttl set to the given value (ie 1s ; cf elasticsearch time limits (opens new window)) |
scrollId | String | The scrollId if using scroll option |
sort | List | Contains a list of fields, used to sort search results (opens new window), in order of importance. |
Overrided operators #
The []
and []=
are overrided so you can dynamically add any args you want to this class and it will be taken in consideration in the request sent to Kuzzle.