com.algolia.search

Interface SyncObjects<T>

All Superinterfaces:

AbstractIndex<T>, Serializable, SyncBaseIndex<T>

All Known Implementing Classes:

Index

public interface SyncObjects<T>
extends SyncBaseIndex<T>

Method Summary

Modifier and Type	Method and Description
default TaskIndexing	addObject(String objectID, T object) Add an object in this index with a unique identifier
default TaskIndexing	addObject(String objectID, T object, RequestOptions requestOptions) Add an object in this index with a unique identifier
default TaskIndexing	addObject(T object) Add an object in this index
default TaskIndexing	addObject(T object, RequestOptions requestOptions) Add an object in this index
default TaskSingleIndex	addObjects(List<T> objects) Add several objects
default TaskSingleIndex	addObjects(List<T> objects, RequestOptions requestOptions) Add several objects
default Task	deleteObject(String objectID) Delete an object from the index
default Task	deleteObject(String objectID, RequestOptions requestOptions) Delete an object from the index
default TaskSingleIndex	deleteObjects(List<String> objectIDs) Delete objects from the index
default TaskSingleIndex	deleteObjects(List<String> objectIDs, RequestOptions requestOptions) Delete objects from the index
default Optional<T>	getObject(String objectID) Get an object from this index
default Optional<T>	getObject(String objectID, RequestOptions requestOptions) Get an object from this index
default List<T>	getObjects(List<String> objectIDs) Get several objects from this index
default List<T>	getObjects(List<String> objectIDs, List<String> attributesToRetrieve) Get several objects from this index
default List<T>	getObjects(List<String> objectIDs, List<String> attributesToRetrieve, RequestOptions requestOptions) Get several objects from this index
default List<T>	getObjects(List<String> objectIDs, RequestOptions requestOptions) Get several objects from this index
default Task	saveObject(String objectID, T object) Override the content of object
default Task	saveObject(String objectID, T object, RequestOptions requestOptions) Override the content of object
default TaskSingleIndex	saveObjects(List<T> objects) Override the content the list of objects
default TaskSingleIndex	saveObjects(List<T> objects, RequestOptions requestOptions) Override the content the list of objects

Methods inherited from interface com.algolia.search.SyncBaseIndex

getApiClient

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Method Detail

addObject

default TaskIndexing addObject(@Nonnull
                               T object)
                        throws AlgoliaException

Add an object in this index

Parameters:

object - object to add

Returns:

the associated Task

Throws:

AlgoliaException

addObject

default TaskIndexing addObject(@Nonnull
                               T object,
                               @Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

Add an object in this index

Parameters:

object - object to add

requestOptions - Options to pass to this request

Returns:

the associated Task

Throws:

AlgoliaException

addObject

default TaskIndexing addObject(@Nonnull
                               String objectID,
                               @Nonnull
                               T object)
                        throws AlgoliaException

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 Task

Throws:

AlgoliaException

addObject

default TaskIndexing addObject(@Nonnull
                               String objectID,
                               @Nonnull
                               T object,
                               @Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

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 Task

Throws:

AlgoliaException

addObjects

default TaskSingleIndex addObjects(@Nonnull
                                   List<T> objects)
                            throws AlgoliaException

Add several objects

Parameters:

objects - objects to add

Returns:

the associated Task

Throws:

AlgoliaException

addObjects

default TaskSingleIndex addObjects(@Nonnull
                                   List<T> objects,
                                   @Nonnull
                                   RequestOptions requestOptions)
                            throws AlgoliaException

Add several objects

Parameters:

objects - objects to add

requestOptions - Options to pass to this request

Returns:

the associated Task

Throws:

AlgoliaException

getObject

default Optional<T> getObject(@Nonnull
                              String objectID)
                       throws AlgoliaException

Get an object from this index

Parameters:

objectID - the unique identifier of the object to retrieve

Returns:

The object

Throws:

AlgoliaException

getObject

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

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

Throws:

AlgoliaException

getObjects

default List<T> getObjects(@Nonnull
                           List<String> objectIDs)
                    throws AlgoliaException

Get several objects from this index

Parameters:

objectIDs - the list of unique identifier of objects to retrieve

Returns:

the list of objects

Throws:

AlgoliaException

getObjects

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

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

Throws:

AlgoliaException

getObjects

default List<T> getObjects(@Nonnull
                           List<String> objectIDs,
                           @Nonnull
                           List<String> attributesToRetrieve)
                    throws AlgoliaException

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

Throws:

AlgoliaException

getObjects

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

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

Throws:

AlgoliaException

saveObject

default Task saveObject(@Nonnull
                        String objectID,
                        @Nonnull
                        T object)
                 throws AlgoliaException

Override the content of object

Parameters:

objectID - the unique identifier of the object to retrieve

object - the object to update

Returns:

the associated Task

Throws:

AlgoliaException

saveObject

default Task saveObject(@Nonnull
                        String objectID,
                        @Nonnull
                        T object,
                        @Nonnull
                        RequestOptions requestOptions)
                 throws AlgoliaException

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 Task

Throws:

AlgoliaException

saveObjects

default TaskSingleIndex saveObjects(@Nonnull
                                    List<T> objects)
                             throws AlgoliaException

Override the content the list of objects

Parameters:

objects - the list objects to update

Returns:

the associated Task

Throws:

AlgoliaException

saveObjects

default TaskSingleIndex saveObjects(@Nonnull
                                    List<T> objects,
                                    @Nonnull
                                    RequestOptions requestOptions)
                             throws AlgoliaException

Override the content the list of objects

Parameters:

objects - the list objects to update

requestOptions - Options to pass to this request

Returns:

the associated Task

Throws:

AlgoliaException

deleteObject

default Task deleteObject(@Nonnull
                          String objectID)
                   throws AlgoliaException

Delete an object from the index

Parameters:

objectID - the unique identifier of the object to retrieve

Returns:

the associated Task

Throws:

AlgoliaException

deleteObject

default Task deleteObject(@Nonnull
                          String objectID,
                          @Nonnull
                          RequestOptions requestOptions)
                   throws AlgoliaException

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 Task

Throws:

AlgoliaException

deleteObjects

default TaskSingleIndex deleteObjects(@Nonnull
                                      List<String> objectIDs)
                               throws AlgoliaException

Delete objects from the index

Parameters:

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

Returns:

the associated Task

Throws:

AlgoliaException

deleteObjects

default TaskSingleIndex deleteObjects(@Nonnull
                                      List<String> objectIDs,
                                      @Nonnull
                                      RequestOptions requestOptions)
                               throws AlgoliaException

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 Task

Throws:

AlgoliaException