getSpecifications

Returns the validation specifications associated to the collection.

Signature

Copied to clipboard!
  public String getSpecifications(String index, String collection) 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 getSpecifications(String index, String collection, 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 Query options no

options

Additional query options

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

Return

Return a string in JSON format representing the validation specifications.

Exceptions

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

Usage

Copied to clipboard!
try {
  kuzzle.getCollection().getSpecifications("nyc-open-data", "yellow-taxi");
  System.out.println("Success");
} catch (KuzzleException e) {
  System.err.println(e.getMessage());
}