getMapping #
Retrieves the current mapping of this collection as a CollectionMapping object.
getMapping([options], callback) #
Arguments | Type | Description |
---|---|---|
options | JSON object | Optional parameters |
callback | function | Callback handling the response |
Options #
Option | Type | Description | Default |
---|---|---|---|
queuable | boolean | Make this request queuable or not | true |
Callback Response #
Returns a CollectionMapping object.
Usage #
kuzzle
.collection("collection", "index")
.getMapping(new ResponseListener<CollectionMapping>() {
@Override
public void onSuccess(CollectionMapping object) {
// result is a CollectionMapping object
}
@Override
public void onError(JSONObject error) {
// Handle error
}
});
Edit this page on Github(opens new window)