Package com.algolia.search

Interface AsyncPartialUpdate<T>

All Superinterfaces:

AbstractIndex<T>, AsyncBaseIndex<T>, Serializable

All Known Implementing Classes:

AsyncIndex

public interface AsyncPartialUpdate<T>
extends AsyncBaseIndex<T>

Method Summary

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

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Methods inherited from interface com.algolia.search.AsyncBaseIndex

getApiClient

Method Detail

partialUpdateObject

default 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

partialUpdateObject

default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                    String objectID,
                                                                    @Nonnull
                                                                    Object object,
                                                                    @Nonnull
                                                                    RequestOptions requestOptions)

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

See Also:

subclasses

partialUpdateObjects

default 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

partialUpdateObjects

default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObjects(@Nonnull
                                                                     List<Object> objects,
                                                                     @Nonnull
                                                                     RequestOptions requestOptions)

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

partialUpdateObjects

default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObjects(@Nonnull
                                                                     List<Object> objects,
                                                                     boolean createIfNotExists,
                                                                     @Nonnull
                                                                     RequestOptions requestOptions)

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

requestOptions - Options to pass to this request

Returns:

the associated task

partialUpdateObjects

default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObjects(@Nonnull
                                                                     List<Object> objects,
                                                                     boolean createIfNotExists)

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

partialUpdateObject

default 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

default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                    PartialUpdateOperation operation,
                                                                    @Nonnull
                                                                    RequestOptions requestOptions)

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

See Also:

subclasses

partialUpdateObject

default 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

partialUpdateObject

default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                    PartialUpdateOperation operation,
                                                                    boolean createIfNotExists,
                                                                    @Nonnull
                                                                    RequestOptions requestOptions)

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

See Also:

subclasses