com.algolia.search

Class AsyncIndex<T>

java.lang.Object

com.algolia.search.AsyncIndex<T>

public class AsyncIndex<T>
extends Object

Nested Class Summary

Nested classes/interfaces inherited from interface com.algolia.search.AbstractIndex

AbstractIndex.Attributes

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<CreateUpdateKey>	addApiKey(ApiKey key) Add a key to this index
default CompletableFuture<CreateUpdateKey>	addKey(ApiKey key) Deprecated.
default CompletableFuture<AsyncTaskIndexing>	addObject(String objectID, T object) Add an object in this index with a unique identifier
default CompletableFuture<AsyncTaskIndexing>	addObject(T object) Add an object in this index
default CompletableFuture<AsyncTaskSingleIndex>	addObjects(List<T> objects) Add several objects
CompletableFuture<AsyncTaskSingleIndex>	batch(List<BatchOperation> operations) Custom batch
default CompletableFuture<AsyncTask>	batchSynonyms(List<AbstractSynonym> synonyms) Add or Replace a list of synonyms, no forward to slaves, and no replacement
default CompletableFuture<AsyncTask>	batchSynonyms(List<AbstractSynonym> synonyms, boolean forwardToReplicas) Add or Replace a list of synonyms, no replacement
default CompletableFuture<AsyncTask>	batchSynonyms(List<AbstractSynonym> synonyms, boolean forwardToReplicas, boolean replaceExistingSynonyms) Add or Replace a list of synonyms
default CompletableFuture<AsyncTask>	clear() Delete the index content without removing settings and index specific API keys.
default CompletableFuture<AsyncTask>	clearSynonyms() Clear all synonyms and NOT forwarding it to the slaves
default CompletableFuture<AsyncTask>	clearSynonyms(boolean forwardToReplicas) Clears all synonyms
default CompletableFuture<AsyncTask>	copyTo(String dstIndexName) Copy an existing index
default CompletableFuture<AsyncTask>	delete() Deletes the index
default CompletableFuture<DeleteKey>	deleteApiKey(String key) Delete a key by name from this index
default CompletableFuture<DeleteKey>	deleteKey(String key) Deprecated.
default CompletableFuture<AsyncTask>	deleteObject(String objectID) Delete an object from the index
default CompletableFuture<AsyncTaskSingleIndex>	deleteObjects(List<String> objectIDs) Delete objects from the index
default CompletableFuture<AsyncTask>	deleteSynonym(String synonymID) Deletes a synonym by ID and NOT forwarding it to the slaves
default CompletableFuture<AsyncTask>	deleteSynonym(String synonymID, boolean forwardToReplicas) Deletes a synonym
AsyncAPIClient	getApiClient()
default CompletableFuture<Optional<ApiKey>>	getApiKey(String key) Get a key by name from this index
default CompletableFuture<Optional<ApiKey>>	getKey(String key) Deprecated.
Class<T>	getKlass()
String	getName()
default CompletableFuture<Optional<T>>	getObject(String objectID) Get an object from this index
default CompletableFuture<List<T>>	getObjects(List<String> objectIDs) Get several objects from this index
default CompletableFuture<List<T>>	getObjects(List<String> objectIDs, List<String> attributesToRetrieve) Get several objects from this index
default CompletableFuture<IndexSettings>	getSettings() Get settings of this index
default CompletableFuture<Optional<AbstractSynonym>>	getSynonym(String synonymID) Get a synonym by ID
default CompletableFuture<List<ApiKey>>	listApiKeys() List keys of this index
default CompletableFuture<List<ApiKey>>	listKeys() Deprecated.
default CompletableFuture<AsyncTask>	moveTo(String dstIndexName) Moves an existing index
default CompletableFuture<AsyncTaskSingleIndex>	partialUpdateObject(PartialUpdateOperation operation) Partially update an object, create the object if it does not exist
default CompletableFuture<AsyncTaskSingleIndex>	partialUpdateObject(PartialUpdateOperation operation, boolean createIfNotExists) Partially update an object
default CompletableFuture<AsyncTaskSingleIndex>	partialUpdateObject(String objectID, Object object) Partially update an object
default CompletableFuture<AsyncTaskSingleIndex>	partialUpdateObjects(List<Object> objects) Partially update a objects
default CompletableFuture<AsyncTask>	saveObject(String objectID, T object) Override the content of object
default CompletableFuture<AsyncTaskSingleIndex>	saveObjects(List<T> objects) Override the content the list of objects
default CompletableFuture<AsyncTask>	saveSynonym(String synonymID, AbstractSynonym content) Saves/updates a synonym without replacing it and NOT forwarding it to the slaves
default CompletableFuture<AsyncTask>	saveSynonym(String synonymID, AbstractSynonym content, boolean forwardToReplicas) Saves/updates a synonym without replacing
default CompletableFuture<AsyncTask>	saveSynonym(String synonymID, AbstractSynonym content, boolean forwardToReplicas, boolean replaceExistingSynonyms) Saves/updates a synonym
CompletableFuture<SearchResult<T>>	search(Query query) Search in the index
default CompletableFuture<SearchFacetResult>	searchFacet(String facetName, String facetQuery) Deprecated.
default CompletableFuture<SearchFacetResult>	searchFacet(String facetName, String facetQuery, Query query) Deprecated.
default CompletableFuture<SearchFacetResult>	searchForFacetValues(String facetName, String facetQuery) Search in a facet
default CompletableFuture<SearchFacetResult>	searchForFacetValues(String facetName, String facetQuery, Query query) Search in a facet
default CompletableFuture<SearchFacetResult>	searchInFacetValues(String facetName, String facetQuery) Deprecated.
default CompletableFuture<SearchFacetResult>	searchInFacetValues(String facetName, String facetQuery, Query query) Deprecated.
default CompletableFuture<SearchSynonymResult>	searchSynonyms(SynonymQuery query) Search for synonyms
default CompletableFuture<AsyncTask>	setSettings(IndexSettings settings) 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<CreateUpdateKey>	updateApiKey(String keyName, ApiKey key) Update a key by name from this index
default CompletableFuture<CreateUpdateKey>	updateKey(String keyName, ApiKey key) Deprecated.
default void	waitTask(AsyncTask task) Wait for the completion of a task, for 100ms
default void	waitTask(AsyncTask task, long timeToWait) Wait for the completion of a task

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public String getName()

getKlass

public Class<T> getKlass()

getApiClient

public AsyncAPIClient getApiClient()

search

public CompletableFuture<SearchResult<T>> search(@Nonnull
                                                 Query query)

Search in the index

Parameters:

query - the query

Returns:

the result of the search, or a failed Future if the index does not exists

batch

public CompletableFuture<AsyncTaskSingleIndex> batch(@Nonnull
                                                     List<BatchOperation> operations)

Custom batch

All operations must have index name set to null

Parameters:

operations - the list of operations to perform on this index

Returns:

the associated task

See Also:

& subclasses

moveTo

public CompletableFuture<AsyncTask> moveTo(@Nonnull
                                           String dstIndexName)

Moves an existing index

Parameters:

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist)

Returns:

The task associated

copyTo

public CompletableFuture<AsyncTask> copyTo(@Nonnull
                                           String dstIndexName)

Copy an existing index

Parameters:

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overridden if it already exist)

Returns:

The task associated

delete

public CompletableFuture<AsyncTask> delete()

Deletes the index

Returns:

the related AsyncTask

clear

public CompletableFuture<AsyncTask> clear()

Delete the index content without removing settings and index specific API keys.

Returns:

the related AsyncTask

waitTask

public void waitTask(@Nonnull
                     AsyncTask task,
                     long timeToWait)

Wait for the completion of a task

Parameters:

task - task to wait for

timeToWait - the time to wait in milliseconds

waitTask

public void waitTask(@Nonnull
                     AsyncTask task)

Wait for the completion of a task, for 100ms

Parameters:

task - task to wait for

addObject

public CompletableFuture<AsyncTaskIndexing> addObject(@Nonnull
                                                      T object)

Add an object in this index

Parameters:

object - object to add

Returns:

the related AsyncTask

addObject

public CompletableFuture<AsyncTaskIndexing> addObject(@Nonnull
                                                      String objectID,
                                                      @Nonnull
                                                      T object)

Add an object in this index with a unique identifier

Parameters:

objectID - the objectID associated to this object (if this objectID already exist the old object will be overridden)

object - object to add

Returns:

the related AsyncTask

addObjects

public CompletableFuture<AsyncTaskSingleIndex> addObjects(@Nonnull
                                                          List<T> objects)

Add several objects

Parameters:

objects - objects to add

Returns:

the related AsyncTask

getObject

public CompletableFuture<Optional<T>> getObject(@Nonnull
                                                String objectID)

Get an object from this index

Parameters:

objectID - the unique identifier of the object to retrieve

Returns:

The object

getObjects

public CompletableFuture<List<T>> getObjects(@Nonnull
                                             List<String> objectIDs)

Get several objects from this index

Parameters:

objectIDs - the list of unique identifier of objects to retrieve

Returns:

the list of objects

getObjects

public CompletableFuture<List<T>> getObjects(@Nonnull
                                             List<String> objectIDs,
                                             @Nonnull
                                             List<String> attributesToRetrieve)

Get several objects from this index

Parameters:

objectIDs - the list of unique identifier of objects to retrieve

attributesToRetrieve - the list of attributes to retrieve for these objects

Returns:

the list of objects

saveObject

public CompletableFuture<AsyncTask> saveObject(@Nonnull
                                               String objectID,
                                               @Nonnull
                                               T object)

Override the content of object

Parameters:

objectID - the unique identifier of the object to retrieve

object - the object to update

Returns:

the related AsyncTask

saveObjects

public CompletableFuture<AsyncTaskSingleIndex> saveObjects(@Nonnull
                                                           List<T> objects)

Override the content the list of objects

Parameters:

objects - the list objects to update

Returns:

the related AsyncTask

deleteObject

public CompletableFuture<AsyncTask> deleteObject(@Nonnull
                                                 String objectID)

Delete an object from the index

Parameters:

objectID - the unique identifier of the object to retrieve

Returns:

the related AsyncTask

deleteObjects

public CompletableFuture<AsyncTaskSingleIndex> deleteObjects(@Nonnull
                                                             List<String> objectIDs)

Delete objects from the index

Parameters:

objectIDs - the list of unique identifier of the object to retrieve

Returns:

the related AsyncTask

getSettings

public CompletableFuture<IndexSettings> getSettings()

Get settings of this index

Returns:

the settings

setSettings

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

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

Parameters:

settings - the settings to set

Returns:

the related AsyncTask

setSettings

public 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 slaves

Returns:

the related AsyncTask

listKeys

@Deprecated
public CompletableFuture<List<ApiKey>> listKeys()

Deprecated.

Deprecated: use listApiKeys

listApiKeys

public CompletableFuture<List<ApiKey>> listApiKeys()

List keys of this index

Returns:

the list of keys

getKey

@Deprecated
public CompletableFuture<Optional<ApiKey>> getKey(@Nonnull
                                                              String key)

Deprecated.

Deprecated: use getApiKey

getApiKey

public CompletableFuture<Optional<ApiKey>> getApiKey(@Nonnull
                                                     String key)

Get a key by name from this index

Parameters:

key - the key name

Returns:

the key

deleteKey

@Deprecated
public CompletableFuture<DeleteKey> deleteKey(@Nonnull
                                                          String key)

Deprecated.

Deprecated: use deleteApiKey

deleteApiKey

public CompletableFuture<DeleteKey> deleteApiKey(@Nonnull
                                                 String key)

Delete a key by name from this index

Parameters:

key - the key name

Returns:

the deleted key

addKey

@Deprecated
public CompletableFuture<CreateUpdateKey> addKey(@Nonnull
                                                             ApiKey key)

Deprecated.

Deprecated: use addApiKey

addApiKey

public CompletableFuture<CreateUpdateKey> addApiKey(@Nonnull
                                                    ApiKey key)

Add a key to this index

Parameters:

key - the key

Returns:

the created key

updateKey

@Deprecated
public CompletableFuture<CreateUpdateKey> updateKey(@Nonnull
                                                                String keyName,
                                                                @Nonnull
                                                                ApiKey key)

Deprecated.

Deprecated: use updateApiKey

updateApiKey

public CompletableFuture<CreateUpdateKey> updateApiKey(@Nonnull
                                                       String keyName,
                                                       @Nonnull
                                                       ApiKey key)

Update a key by name from this index

Parameters:

keyName - the key name

key - the key to update

Returns:

the updated key

searchForFacetValues

public CompletableFuture<SearchFacetResult> searchForFacetValues(@Nonnull
                                                                 String facetName,
                                                                 @Nonnull
                                                                 String facetQuery,
                                                                 Query query)

Search in a facet

Parameters:

facetName - The name of the facet to search in

facetQuery - The search query for this facet

query - the query (not required)

Returns:

the result of the search

searchForFacetValues

public CompletableFuture<SearchFacetResult> searchForFacetValues(@Nonnull
                                                                 String facetName,
                                                                 @Nonnull
                                                                 String facetQuery)

Search in a facet

Parameters:

facetName - The name of the facet to search in

facetQuery - The search query for this facet

Returns:

the result of the search

searchInFacetValues

@Deprecated
public CompletableFuture<SearchFacetResult> searchInFacetValues(@Nonnull
                                                                            String facetName,
                                                                            @Nonnull
                                                                            String facetQuery,
                                                                            Query query)

Deprecated.

searchInFacetValues

@Deprecated
public CompletableFuture<SearchFacetResult> searchInFacetValues(@Nonnull
                                                                            String facetName,
                                                                            @Nonnull
                                                                            String facetQuery)

Deprecated.

searchFacet

@Deprecated
public CompletableFuture<SearchFacetResult> searchFacet(@Nonnull
                                                                    String facetName,
                                                                    @Nonnull
                                                                    String facetQuery,
                                                                    Query query)

Deprecated.

searchFacet

@Deprecated
public CompletableFuture<SearchFacetResult> searchFacet(@Nonnull
                                                                    String facetName,
                                                                    @Nonnull
                                                                    String facetQuery)

Deprecated.

partialUpdateObject

public CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                   String objectID,
                                                                   @Nonnull
                                                                   Object object)

Partially update an object

Parameters:

objectID - the ID of object to update

object - the object to update

Returns:

the associated task

See Also:

& subclasses

partialUpdateObjects

public CompletableFuture<AsyncTaskSingleIndex> partialUpdateObjects(@Nonnull
                                                                    List<Object> objects)

Partially update a objects

Parameters:

objects - the list of objects to update (with an objectID)

Returns:

the associated task

partialUpdateObject

public CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                   PartialUpdateOperation operation)

Partially update an object, create the object if it does not exist

Parameters:

operation - the operation to perform on this object

Returns:

the associated task

See Also:

& subclasses

partialUpdateObject

public CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                   PartialUpdateOperation operation,
                                                                   boolean createIfNotExists)

Partially update an object

Parameters:

operation - the operation to perform on this object

createIfNotExists - should the object be created or not

Returns:

the associated task

See Also:

& subclasses

saveSynonym

public CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                String synonymID,
                                                @Nonnull
                                                AbstractSynonym content)

Saves/updates a synonym without replacing it and NOT forwarding it to the slaves

Parameters:

synonymID - the id of the synonym

content - the synonym

Returns:

the associated task

saveSynonym

public CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                String synonymID,
                                                @Nonnull
                                                AbstractSynonym content,
                                                boolean forwardToReplicas)

Saves/updates a synonym without replacing

Parameters:

synonymID - the id of the synonym

content - the synonym

forwardToReplicas - should this request be forwarded to slaves

Returns:

the associated task

saveSynonym

public CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                String synonymID,
                                                @Nonnull
                                                AbstractSynonym content,
                                                boolean forwardToReplicas,
                                                boolean replaceExistingSynonyms)

Saves/updates a synonym

Parameters:

synonymID - the id of the synonym

content - the synonym

forwardToReplicas - should this request be forwarded to slaves

replaceExistingSynonyms - should replace if this synonyms exists

Returns:

the associated task

getSynonym

public CompletableFuture<Optional<AbstractSynonym>> getSynonym(@Nonnull
                                                               String synonymID)

Get a synonym by ID

Parameters:

synonymID - the id of the synonym

Returns:

the associated task

deleteSynonym

public CompletableFuture<AsyncTask> deleteSynonym(@Nonnull
                                                  String synonymID)

Deletes a synonym by ID and NOT forwarding it to the slaves

Parameters:

synonymID - the id of the synonym

Returns:

the associated task

deleteSynonym

public CompletableFuture<AsyncTask> deleteSynonym(@Nonnull
                                                  String synonymID,
                                                  boolean forwardToReplicas)

Deletes a synonym

Parameters:

synonymID - the id of the synonym

forwardToReplicas - should this request be forwarded to slaves

Returns:

the associated task

clearSynonyms

public CompletableFuture<AsyncTask> clearSynonyms()

Clear all synonyms and NOT forwarding it to the slaves

Returns:

the associated task

clearSynonyms

public CompletableFuture<AsyncTask> clearSynonyms(boolean forwardToReplicas)

Clears all synonyms

Returns:

the associated task

searchSynonyms

public CompletableFuture<SearchSynonymResult> searchSynonyms(@Nonnull
                                                             SynonymQuery query)

Search for synonyms

Parameters:

query - the query

Returns:

the results of the query

batchSynonyms

public CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                  List<AbstractSynonym> synonyms,
                                                  boolean forwardToReplicas,
                                                  boolean replaceExistingSynonyms)

Add or Replace a list of synonyms

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward the operation to the slave indices

replaceExistingSynonyms - Replace the existing synonyms with this batch

Returns:

the associated task

batchSynonyms

public CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                  List<AbstractSynonym> synonyms,
                                                  boolean forwardToReplicas)

Add or Replace a list of synonyms, no replacement

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward the operation to the slave indices

Returns:

the associated task

batchSynonyms

public CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                  List<AbstractSynonym> synonyms)

Add or Replace a list of synonyms, no forward to slaves, and no replacement

Parameters:

synonyms - List of synonyms

Returns:

the associated task