SDK
SDK Java v1.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

This SDK has been deprecated because of stability issues. It is not advised to use it in a production environment.

List #

Get the complete list of indexes handled by Kuzzle.

Signature #

Copied to clipboard!
io.kuzzle.sdk.StringVector list() throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException;
io.kuzzle.sdk.StringVector list(io.kuzzle.sdk.QueryOptions options) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException;

Arguments #

Arguments Type Description
options io.kuzzle.sdk.QueryOptions The query options

Options #

Additional query options

Option Type Description Default
queuable boolean Make this request queuable or not true

Return #

Returns an io.kuzzle.sdk.StringVector containing the list of indexes names present in Kuzzle.

Exceptions #

Throws a io.kuzzle.sdk.KuzzleException if there is an error. See how to handle error.

Usage #

Copied to clipboard!
StringVector indexes = kuzzle.getIndex().list();
for (int i = 0; i < indexes.size(); ++i) {
  System.out.println(indexes.get(i));
}
System.out.println(String.format("Kuzzle contains %d indexes", indexes.size()));