Package com.algolia.search

Interface SearchIndexSettings<T>

Type Parameters:

T -

All Superinterfaces:

SearchIndexBase<T>

All Known Implementing Classes:

SearchIndex

public interface SearchIndexSettings<T>
extends SearchIndexBase<T>

This interface holds all endpoints for Index Settings.

Method Summary

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

Methods inherited from interface com.algolia.search.SearchIndexBase

getClazz, getConfig, getTransport, getUrlEncodedIndexName, waitTask, waitTask

Method Detail

setSettings

default SetSettingsResponse setSettings(@Nonnull
                                        IndexSettings settings)

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

Parameters:

settings - the settings to set

setSettings

default SetSettingsResponse setSettings(@Nonnull
                                        IndexSettings settings,
                                        @Nonnull
                                        Boolean forwardToReplicas)

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

Parameters:

settings - the settings to set

forwardToReplicas - if true forward the settings to the replicas

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

setSettings

default SetSettingsResponse setSettings(@Nonnull
                                        IndexSettings settings,
                                        @Nonnull
                                        Boolean forwardToReplicas,
                                        @Nonnull
                                        RequestOptions requestOptions)

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

Parameters:

settings - the settings to set

forwardToReplicas - if true forward the settings to the replicas

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

setSettings

default SetSettingsResponse setSettings(@Nonnull
                                        IndexSettings settings,
                                        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

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

setSettingsAsync

default CompletableFuture<SetSettingsResponse> setSettingsAsync(@Nonnull
                                                                IndexSettings settings)

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

Parameters:

settings - the settings to set

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

setSettingsAsync

default CompletableFuture<SetSettingsResponse> setSettingsAsync(@Nonnull
                                                                IndexSettings settings,
                                                                @Nonnull
                                                                Boolean forwardToReplicas)

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

Parameters:

settings - the settings to set

forwardToReplicas - if true forward the settings to the replicas

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

setSettingsAsync

default CompletableFuture<SetSettingsResponse> setSettingsAsync(@Nonnull
                                                                IndexSettings settings,
                                                                @Nonnull
                                                                Boolean forwardToReplicas,
                                                                @Nonnull
                                                                RequestOptions requestOptions)

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

Parameters:

settings - the settings to set

forwardToReplicas - if true forward the settings to the replicas

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

setSettingsAsync

default CompletableFuture<SetSettingsResponse> setSettingsAsync(@Nonnull
                                                                IndexSettings settings,
                                                                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

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getSettings

default IndexSettings getSettings()

Get the settings of an index.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getSettings

default IndexSettings getSettings(RequestOptions requestOptions)

Get the settings of an index.

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getSettingsAsync

default CompletableFuture<IndexSettings> getSettingsAsync()

Get the settings of an index.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getSettingsAsync

default CompletableFuture<IndexSettings> getSettingsAsync(RequestOptions requestOptions)

Get the settings of an index.

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization