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.

Delete #

Deletes an entire index from Kuzzle.

Signature #

void delete(String index) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException;
void delete(String index, 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 #

ArgumentsTypeDescriptionRequired
indexStringIndex nameyes
optionsio.kuzzle.sdk.QueryOptionsThe query optionsno

Options #

Additional query options

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Exceptions #

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

Usage #

try {
  kuzzle.getIndex().delete("nyc-open-data");
  System.out.println("index deleted");
} catch (KuzzleException e) {
  System.err.println(e.getMessage());
}