list #

Returns the complete list of realtime and stored collections in requested index sorted by name in alphanumerical order. The from and size arguments allow pagination. They are returned in the response if provided.

Signature #

Copied to clipboard!

public String list(String index) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException, io.kuzzle.sdk.NotFoundException;
public String list(String index, io.kuzzle.sdk.QueryOptions io.kuzzle.sdk.QueryOptions) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException, io.kuzzle.sdk.NotFoundException;

Arguments #

Arguments	Type	Description	Required
index	String	Index name	yes
collection	String	Collection name	yes
options	io.kuzzle.sdk.QueryOptions	An object containing query options	no

options #

Additional query options

Property	Type	Description	Default
queuable	boolean	Make this request queuable or not	true
from	int	Offset of the first result	0
size	int	Maximum number of returned results	10

Return #

Returns a string containing a JSON representation of the API response.

Exceptions #

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

Usage #

Copied to clipboard!

try {
  QueryOptions options = new QueryOptions();
  options.setFrom(1);
  options.setSize(1);
  String collectionList = kuzzle.getCollection().list("mtp-open-data", options);
  // {"type":"all","collections":[{"name":"pink-taxi","type":"stored"}],"from":1,"size":2}
  System.out.println("Success");
} catch (KuzzleException e) {
  System.err.println(e.getMessage());
}