com.algolia.search

Interface AsyncObjects<T>

All Superinterfaces:

AbstractIndex<T>, AsyncBaseIndex<T>, Serializable

All Known Implementing Classes:

AsyncIndex

public interface AsyncObjects<T>
extends AsyncBaseIndex<T>

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<AsyncTaskIndexing>	addObject(String objectID, T object) Add an object in this index with a unique identifier
default CompletableFuture<AsyncTaskIndexing>	addObject(String objectID, T object, RequestOptions requestOptions) Add an object in this index with a unique identifier
default CompletableFuture<AsyncTaskIndexing>	addObject(T object) Add an object in this index
default CompletableFuture<AsyncTaskIndexing>	addObject(T object, RequestOptions requestOptions) Add an object in this index
default CompletableFuture<AsyncTaskSingleIndex>	addObjects(List<T> objects) Add several objects
default CompletableFuture<AsyncTaskSingleIndex>	addObjects(List<T> objects, RequestOptions requestOptions) Add several objects
default CompletableFuture<AsyncTask>	deleteObject(String objectID) Delete an object from the index
default CompletableFuture<AsyncTask>	deleteObject(String objectID, RequestOptions requestOptions) Delete an object from the index
default CompletableFuture<AsyncTaskSingleIndex>	deleteObjects(List<String> objectIDs) Delete objects from the index
default CompletableFuture<AsyncTaskSingleIndex>	deleteObjects(List<String> objectIDs, RequestOptions requestOptions) Delete objects from the index
default CompletableFuture<Optional<T>>	getObject(String objectID) Get an object from this index
default CompletableFuture<Optional<T>>	getObject(String objectID, RequestOptions requestOptions) 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<List<T>>	getObjects(List<String> objectIDs, List<String> attributesToRetrieve, RequestOptions requestOptions) Get several objects from this index
default CompletableFuture<List<T>>	getObjects(List<String> objectIDs, RequestOptions requestOptions) Get several objects from this index
default CompletableFuture<AsyncTask>	saveObject(String objectID, T object) Override the content of object
default CompletableFuture<AsyncTask>	saveObject(String objectID, T object, RequestOptions requestOptions) Override the content of object
default CompletableFuture<AsyncTaskSingleIndex>	saveObjects(List<T> objects) Override the content the list of objects
default CompletableFuture<AsyncTaskSingleIndex>	saveObjects(List<T> objects, RequestOptions requestOptions) Override the content the list of objects

Methods inherited from interface com.algolia.search.AsyncBaseIndex

getApiClient

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Method Detail

addObject

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

Add an object in this index

Parameters:

object - object to add

Returns:

the associated AsyncTask

addObject

default CompletableFuture<AsyncTaskIndexing> addObject(@Nonnull
                                                       T object,
                                                       @Nonnull
                                                       RequestOptions requestOptions)

Add an object in this index

Parameters:

object - object to add

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask

addObject

default 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 associated AsyncTask

addObject

default CompletableFuture<AsyncTaskIndexing> addObject(@Nonnull
                                                       String objectID,
                                                       @Nonnull
                                                       T object,
                                                       @Nonnull
                                                       RequestOptions requestOptions)

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

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask

addObjects

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

Add several objects

Parameters:

objects - objects to add

Returns:

the associated AsyncTask

addObjects

default CompletableFuture<AsyncTaskSingleIndex> addObjects(@Nonnull
                                                           List<T> objects,
                                                           @Nonnull
                                                           RequestOptions requestOptions)

Add several objects

Parameters:

objects - objects to add

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask

getObject

default 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

getObject

default CompletableFuture<Optional<T>> getObject(@Nonnull
                                                 String objectID,
                                                 @Nonnull
                                                 RequestOptions requestOptions)

Get an object from this index

Parameters:

objectID - the unique identifier of the object to retrieve

requestOptions - Options to pass to this request

Returns:

The object

getObjects

default 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

default CompletableFuture<List<T>> getObjects(@Nonnull
                                              List<String> objectIDs,
                                              @Nonnull
                                              RequestOptions requestOptions)

Get several objects from this index

Parameters:

objectIDs - the list of unique identifier of objects to retrieve

requestOptions - Options to pass to this request

Returns:

the list of objects

getObjects

default 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

getObjects

default CompletableFuture<List<T>> getObjects(@Nonnull
                                              List<String> objectIDs,
                                              @Nonnull
                                              List<String> attributesToRetrieve,
                                              @Nonnull
                                              RequestOptions requestOptions)

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

requestOptions - Options to pass to this request

Returns:

the list of objects

saveObject

default 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 associated AsyncTask

saveObject

default CompletableFuture<AsyncTask> saveObject(@Nonnull
                                                String objectID,
                                                @Nonnull
                                                T object,
                                                @Nonnull
                                                RequestOptions requestOptions)

Override the content of object

Parameters:

objectID - the unique identifier of the object to retrieve

object - the object to update

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask

saveObjects

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

Override the content the list of objects

Parameters:

objects - the list objects to update

Returns:

the associated AsyncTask

saveObjects

default CompletableFuture<AsyncTaskSingleIndex> saveObjects(@Nonnull
                                                            List<T> objects,
                                                            @Nonnull
                                                            RequestOptions requestOptions)

Override the content the list of objects

Parameters:

objects - the list objects to update

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask

deleteObject

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

Delete an object from the index

Parameters:

objectID - the unique identifier of the object to retrieve

Returns:

the associated AsyncTask

deleteObject

default CompletableFuture<AsyncTask> deleteObject(@Nonnull
                                                  String objectID,
                                                  @Nonnull
                                                  RequestOptions requestOptions)

Delete an object from the index

Parameters:

objectID - the unique identifier of the object to retrieve

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask

deleteObjects

default 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 associated AsyncTask

deleteObjects

default CompletableFuture<AsyncTaskSingleIndex> deleteObjects(@Nonnull
                                                              List<String> objectIDs,
                                                              @Nonnull
                                                              RequestOptions requestOptions)

Delete objects from the index

Parameters:

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

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask