com.algolia.search

Interface SyncDeleteByQuery<T>

All Superinterfaces:

AbstractIndex<T>, Serializable, SyncBaseIndex<T>

All Known Implementing Classes:

Index

public interface SyncDeleteByQuery<T>
extends SyncBaseIndex<T>

Method Summary

Modifier and Type	Method and Description
default Task	deleteBy(Query query) Delete records matching a query
default Task	deleteBy(Query query, RequestOptions requestOptions) Delete records matching a query
default void	deleteByQuery(Query query) Deprecated.
default void	deleteByQuery(Query query, int batchSize) Deprecated.
default void	deleteByQuery(Query query, int batchSize, RequestOptions requestOptions) Deprecated.
default void	deleteByQuery(Query query, RequestOptions requestOptions) Deprecated.

Methods inherited from interface com.algolia.search.SyncBaseIndex

getApiClient

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Method Detail

deleteByQuery

@Deprecated
default void deleteByQuery(@Nonnull
                                       Query query)
                                throws AlgoliaException

Deprecated.

Deprecated: use deleteBy(Query)

Throws:

AlgoliaException

deleteBy

default Task deleteBy(@Nonnull
                      Query query)
               throws AlgoliaException

Delete records matching a query

Parameters:

query - The query

Throws:

AlgoliaException

deleteByQuery

@Deprecated
default void deleteByQuery(@Nonnull
                                       Query query,
                                       @Nonnull
                                       RequestOptions requestOptions)
                                throws AlgoliaException

Deprecated.

Deprecated: use deleteBy(Query, RequestOptions)

Throws:

AlgoliaException

deleteBy

default Task deleteBy(@Nonnull
                      Query query,
                      @Nonnull
                      RequestOptions requestOptions)
               throws AlgoliaException

Delete records matching a query

Parameters:

query - The query

requestOptions - Options to pass to this request

Throws:

AlgoliaException

deleteByQuery

@Deprecated
default void deleteByQuery(@Nonnull
                                       Query query,
                                       int batchSize)
                                throws AlgoliaException

Deprecated.

Deprecated: use deleteBy(Query)

Throws:

AlgoliaException

deleteByQuery

@Deprecated
default void deleteByQuery(@Nonnull
                                       Query query,
                                       int batchSize,
                                       @Nonnull
                                       RequestOptions requestOptions)
                                throws AlgoliaException

Deprecated.

Deprecated: use deleteBy(Query, RequestOptions)

Throws:

AlgoliaException