Package com.algolia.search

Interface AsyncSettings<T>

All Superinterfaces:

AbstractIndex<T>, AsyncBaseIndex<T>, Serializable

All Known Implementing Classes:

AsyncIndex

public interface AsyncSettings<T>
extends AsyncBaseIndex<T>

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<IndexSettings>	getSettings()	Get settings of this index
default CompletableFuture<IndexSettings>	getSettings(RequestOptions requestOptions)	Get settings of this index
default CompletableFuture<AsyncTask>	setSettings(IndexSettings settings)	Set settings of this index, and do not forward to replicas
default CompletableFuture<AsyncTask>	setSettings(IndexSettings settings, RequestOptions requestOptions)	Set settings of this index, and do not forward to slaves
default CompletableFuture<AsyncTask>	setSettings(IndexSettings settings, Boolean forwardToReplicas)	Set settings of this index
default CompletableFuture<AsyncTask>	setSettings(IndexSettings settings, Boolean forwardToReplicas, RequestOptions requestOptions)	Set settings of this index

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Methods inherited from interface com.algolia.search.AsyncBaseIndex

getApiClient

Method Detail

getSettings

default CompletableFuture<IndexSettings> getSettings()

Get settings of this index

Returns:

the settings

getSettings

default CompletableFuture<IndexSettings> getSettings(@Nonnull
                                                     RequestOptions requestOptions)

Get settings of this index

Parameters:

requestOptions - Options to pass to this request

Returns:

the settings

setSettings

default CompletableFuture<AsyncTask> setSettings(@Nonnull
                                                 IndexSettings settings)

Set settings of this index, and do not forward to replicas

Parameters:

settings - the settings to set

Returns:

the associated AsyncTask

setSettings

default CompletableFuture<AsyncTask> setSettings(@Nonnull
                                                 IndexSettings settings,
                                                 @Nonnull
                                                 RequestOptions requestOptions)

Set settings of this index, and do not forward to slaves

Parameters:

settings - the settings to set

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask

setSettings

default CompletableFuture<AsyncTask> setSettings(@Nonnull
                                                 IndexSettings settings,
                                                 @Nonnull
                                                 Boolean forwardToReplicas)

Set settings of this index

Parameters:

settings - the settings to set

forwardToReplicas - should these updates be forwarded to the replicas

Returns:

the associated AsyncTask

setSettings

default CompletableFuture<AsyncTask> setSettings(@Nonnull
                                                 IndexSettings settings,
                                                 @Nonnull
                                                 Boolean forwardToReplicas,
                                                 @Nonnull
                                                 RequestOptions requestOptions)

Set settings of this index

Parameters:

settings - the settings to set

forwardToReplicas - should these updates be forwarded to the slaves

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask