com.algolia.search

Interface SyncPartialUpdate<T>

All Superinterfaces:

AbstractIndex<T>, Serializable, SyncBaseIndex<T>

All Known Implementing Classes:

Index

public interface SyncPartialUpdate<T>
extends SyncBaseIndex<T>

Method Summary

Modifier and Type	Method and Description
default TaskSingleIndex	partialUpdateObject(PartialUpdateOperation operation) Partially update an object, create the object if it does not exist
default TaskSingleIndex	partialUpdateObject(PartialUpdateOperation operation, boolean createIfNotExists) Partially update an object
default TaskSingleIndex	partialUpdateObject(PartialUpdateOperation operation, boolean createIfNotExists, RequestOptions requestOptions) Partially update an object
default TaskSingleIndex	partialUpdateObject(PartialUpdateOperation operation, RequestOptions requestOptions) Partially update an object, create the object if it does not exist
default TaskSingleIndex	partialUpdateObject(String objectID, Object object) Partially update an object
default TaskSingleIndex	partialUpdateObject(String objectID, Object object, RequestOptions requestOptions) Partially update an object
default TaskSingleIndex	partialUpdateObjects(List<Object> objects) Partially update a objects
default TaskSingleIndex	partialUpdateObjects(List<Object> objects, boolean createIfNotExists) Partially update a objects
default TaskSingleIndex	partialUpdateObjects(List<Object> objects, boolean createIfNotExists, RequestOptions requestOptions) Partially update a objects
default TaskSingleIndex	partialUpdateObjects(List<Object> objects, RequestOptions requestOptions) Partially update a objects

Methods inherited from interface com.algolia.search.SyncBaseIndex

getApiClient

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Method Detail

partialUpdateObject

default TaskSingleIndex partialUpdateObject(@Nonnull
                                            String objectID,
                                            @Nonnull
                                            Object object)
                                     throws AlgoliaException

Partially update an object

Parameters:

objectID - the ID of object to update

object - the object to update

Returns:

the associated task

Throws:

AlgoliaException

See Also:

& subclasses

partialUpdateObject

default TaskSingleIndex partialUpdateObject(@Nonnull
                                            String objectID,
                                            @Nonnull
                                            Object object,
                                            @Nonnull
                                            RequestOptions requestOptions)
                                     throws AlgoliaException

Partially update an object

Parameters:

objectID - the ID of object to update

object - the object to update

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

See Also:

& subclasses

partialUpdateObjects

default TaskSingleIndex partialUpdateObjects(@Nonnull
                                             List<Object> objects)
                                      throws AlgoliaException

Partially update a objects

Parameters:

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

Returns:

the associated task

Throws:

AlgoliaException

partialUpdateObjects

default TaskSingleIndex partialUpdateObjects(@Nonnull
                                             List<Object> objects,
                                             @Nonnull
                                             RequestOptions requestOptions)
                                      throws AlgoliaException

Partially update a objects

Parameters:

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

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

partialUpdateObjects

default TaskSingleIndex partialUpdateObjects(@Nonnull
                                             List<Object> objects,
                                             boolean createIfNotExists,
                                             @Nonnull
                                             RequestOptions requestOptions)
                                      throws AlgoliaException

Partially update a objects

Parameters:

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

requestOptions - Options to pass to this request

createIfNotExists - Value that indicates the object is created if the objectID doesn't exists

Returns:

the associated task

Throws:

AlgoliaException

partialUpdateObjects

default TaskSingleIndex partialUpdateObjects(@Nonnull
                                             List<Object> objects,
                                             boolean createIfNotExists)
                                      throws AlgoliaException

Partially update a objects

Parameters:

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

createIfNotExists - Value that indicates the object is created if the objectID doesn't exists

Returns:

the associated task

Throws:

AlgoliaException

partialUpdateObject

default TaskSingleIndex partialUpdateObject(@Nonnull
                                            PartialUpdateOperation operation)
                                     throws AlgoliaException

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

Throws:

AlgoliaException

See Also:

& subclasses

partialUpdateObject

default TaskSingleIndex partialUpdateObject(@Nonnull
                                            PartialUpdateOperation operation,
                                            @Nonnull
                                            RequestOptions requestOptions)
                                     throws AlgoliaException

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

Parameters:

operation - the operation to perform on this object

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

See Also:

& subclasses

partialUpdateObject

default TaskSingleIndex partialUpdateObject(@Nonnull
                                            PartialUpdateOperation operation,
                                            boolean createIfNotExists)
                                     throws AlgoliaException

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

Throws:

AlgoliaException

See Also:

& subclasses

partialUpdateObject

default TaskSingleIndex partialUpdateObject(@Nonnull
                                            PartialUpdateOperation operation,
                                            boolean createIfNotExists,
                                            @Nonnull
                                            RequestOptions requestOptions)
                                     throws AlgoliaException

Partially update an object

Parameters:

operation - the operation to perform on this object

createIfNotExists - should the object be created or not

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

See Also:

& subclasses