public interface SyncObjects<T> extends SyncBaseIndex<T>
| 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
|
getApiClientgetKlass, getNamedefault TaskIndexing addObject(@Nonnull T object) throws AlgoliaException
object - object to addAlgoliaExceptiondefault TaskIndexing addObject(@Nonnull T object, @Nonnull RequestOptions requestOptions) throws AlgoliaException
object - object to addrequestOptions - Options to pass to this requestAlgoliaExceptiondefault TaskIndexing addObject(@Nonnull String objectID, @Nonnull T object) throws AlgoliaException
objectID - the objectID associated to this object (if this objectID already exist the old
object will be overridden)object - object to addAlgoliaExceptiondefault TaskIndexing addObject(@Nonnull String objectID, @Nonnull T object, @Nonnull RequestOptions requestOptions) throws AlgoliaException
objectID - the objectID associated to this object (if this objectID already exist the old
object will be overridden)object - object to addrequestOptions - Options to pass to this requestAlgoliaExceptiondefault TaskSingleIndex addObjects(@Nonnull List<T> objects) throws AlgoliaException
objects - objects to addAlgoliaExceptiondefault TaskSingleIndex addObjects(@Nonnull List<T> objects, @Nonnull RequestOptions requestOptions) throws AlgoliaException
objects - objects to addrequestOptions - Options to pass to this requestAlgoliaExceptiondefault Optional<T> getObject(@Nonnull String objectID) throws AlgoliaException
objectID - the unique identifier of the object to retrieveAlgoliaExceptiondefault Optional<T> getObject(@Nonnull String objectID, @Nonnull RequestOptions requestOptions) throws AlgoliaException
objectID - the unique identifier of the object to retrieverequestOptions - Options to pass to this requestAlgoliaExceptiondefault List<T> getObjects(@Nonnull List<String> objectIDs) throws AlgoliaException
objectIDs - the list of unique identifier of objects to retrieveAlgoliaExceptiondefault List<T> getObjects(@Nonnull List<String> objectIDs, @Nonnull RequestOptions requestOptions) throws AlgoliaException
objectIDs - the list of unique identifier of objects to retrieverequestOptions - Options to pass to this requestAlgoliaExceptiondefault List<T> getObjects(@Nonnull List<String> objectIDs, @Nonnull List<String> attributesToRetrieve) throws AlgoliaException
objectIDs - the list of unique identifier of objects to retrieveattributesToRetrieve - the list of attributes to retrieve for these objectsAlgoliaExceptiondefault List<T> getObjects(@Nonnull List<String> objectIDs, @Nonnull List<String> attributesToRetrieve, @Nonnull RequestOptions requestOptions) throws AlgoliaException
objectIDs - the list of unique identifier of objects to retrieveattributesToRetrieve - the list of attributes to retrieve for these objectsrequestOptions - Options to pass to this requestAlgoliaExceptiondefault Task saveObject(@Nonnull String objectID, @Nonnull T object) throws AlgoliaException
objectID - the unique identifier of the object to retrieveobject - the object to updateAlgoliaExceptiondefault Task saveObject(@Nonnull String objectID, @Nonnull T object, @Nonnull RequestOptions requestOptions) throws AlgoliaException
objectID - the unique identifier of the object to retrieveobject - the object to updaterequestOptions - Options to pass to this requestAlgoliaExceptiondefault TaskSingleIndex saveObjects(@Nonnull List<T> objects) throws AlgoliaException
objects - the list objects to updateAlgoliaExceptiondefault TaskSingleIndex saveObjects(@Nonnull List<T> objects, @Nonnull RequestOptions requestOptions) throws AlgoliaException
objects - the list objects to updaterequestOptions - Options to pass to this requestAlgoliaExceptiondefault Task deleteObject(@Nonnull String objectID) throws AlgoliaException
objectID - the unique identifier of the object to retrieveAlgoliaExceptiondefault Task deleteObject(@Nonnull String objectID, @Nonnull RequestOptions requestOptions) throws AlgoliaException
objectID - the unique identifier of the object to retrieverequestOptions - Options to pass to this requestAlgoliaExceptiondefault TaskSingleIndex deleteObjects(@Nonnull List<String> objectIDs) throws AlgoliaException
objectIDs - the list of unique identifier of the object to retrieveAlgoliaExceptiondefault TaskSingleIndex deleteObjects(@Nonnull List<String> objectIDs, @Nonnull RequestOptions requestOptions) throws AlgoliaException
objectIDs - the list of unique identifier of the object to retrieverequestOptions - Options to pass to this requestAlgoliaExceptionCopyright © 2018. All rights reserved.