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.

info #

Returns information about Kuzzle: available API (base + extended), plugins, external services (Redis, Elasticsearch, ...), servers, etc.

Arguments #

public java.lang.String info(
io.kuzzle.sdk.QueryOptions
);
public java.lang.String info();
ArgumentsTypeDescriptionRequired
optionsio.kuzzle.sdk.QueryOptionsAn object containing query options.no

Options #

Additional query options

PropertyTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return #

Return server information as a String.

Exceptions #

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

Usage #

try {
  String info = new String(kuzzle.getServer().info());
  System.out.println("Kuzzle Server information as JSON string: " + info);
} catch (KuzzleException e) {
  System.err.println(e.getMessage());
}