Package com.algolia.search

Interface SyncSettings<T>

All Superinterfaces:

AbstractIndex<T>, Serializable, SyncBaseIndex<T>

All Known Implementing Classes:

Index

public interface SyncSettings<T>
extends SyncBaseIndex<T>

Method Summary

Modifier and Type	Method	Description
default IndexSettings	getSettings()	Get settings of this index
default IndexSettings	getSettings(RequestOptions requestOptions)	Get settings of this index
default Task	setSettings(IndexSettings settings)	Set settings of this index, and do not forward to replicas
default Task	setSettings(IndexSettings settings, RequestOptions requestOptions)	Set settings of this index, and do not forward to slaves
default Task	setSettings(IndexSettings settings, Boolean forwardToReplicas)	Set settings of this index
default Task	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.SyncBaseIndex

getApiClient

Method Detail

getSettings

default IndexSettings getSettings()
                           throws AlgoliaException

Get settings of this index

Returns:

the settings

Throws:

AlgoliaException

getSettings

default IndexSettings getSettings(@Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Get settings of this index

Parameters:

requestOptions - Options to pass to this request

Returns:

the settings

Throws:

AlgoliaException

setSettings

default Task setSettings(@Nonnull
                         IndexSettings settings)
                  throws AlgoliaException

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

Parameters:

settings - the settings to set

Returns:

the associated Task

Throws:

AlgoliaException

setSettings

default Task setSettings(@Nonnull
                         IndexSettings settings,
                         @Nonnull
                         RequestOptions requestOptions)
                  throws AlgoliaException

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 Task

Throws:

AlgoliaException

setSettings

default Task setSettings(@Nonnull
                         IndexSettings settings,
                         @Nonnull
                         Boolean forwardToReplicas)
                  throws AlgoliaException

Set settings of this index

Parameters:

settings - the settings to set

forwardToReplicas - should these updates be forwarded to the replicas

Returns:

the associated Task

Throws:

AlgoliaException

setSettings

default Task setSettings(@Nonnull
                         IndexSettings settings,
                         @Nonnull
                         Boolean forwardToReplicas,
                         @Nonnull
                         RequestOptions requestOptions)
                  throws AlgoliaException

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 Task

Throws:

AlgoliaException