GetAutoRefresh #

The getAutoRefresh action returns the current autorefresh status for the index.

Each index has an autorefresh flag.
When set to true, each write request trigger a refresh action on Elasticsearch.
Without a refresh after a write request, the documents may not be immediately visible in search.

A refresh operation comes with some performance costs.
While forcing the autoRefresh can be convenient on a development or test environment,
we recommend that you avoid using it in production or at least carefully monitor its implications before using it.

Signature #

boolean getAutoRefresh(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;
boolean getAutoRefresh(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, io.kuzzle.sdk.NotFoundException;

Arguments #

Arguments	Type	Description	Required
`index`	String	Index name	yes
`options`	io.kuzzle.sdk.QueryOptions	The query options	no

Options #

Additional query options

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

Return #

Returns a boolean that indicate the status of the autoRefresh flag.

Exceptions #

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

Usage #

if (kuzzle.getIndex().getAutoRefresh("nyc-open-data")) {
  System.out.println("autorefresh is true");
} else {
  System.out.println("autorefresh is false");
}

Edit this page on Github