Package com.algolia.search

Interface AsyncIndexCRUD<T>

All Superinterfaces:

AbstractIndex<T>, AsyncBaseIndex<T>, Serializable

All Known Implementing Classes:

AsyncIndex

public interface AsyncIndexCRUD<T>
extends AsyncBaseIndex<T>

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AsyncTask>	clear()	Delete the index content without removing settings and index specific API keys.
default CompletableFuture<AsyncTask>	clear(RequestOptions requestOptions)	Delete the index content without removing settings and index specific API keys.
default CompletableFuture<AsyncTask>	copyTo(String dstIndexName)	Copy an existing index
default CompletableFuture<AsyncTask>	copyTo(String dstIndexName, RequestOptions requestOptions)	Copy an existing index
default CompletableFuture<AsyncTask>	copyTo(String dstIndexName, List<String> scope)	Copy an existing index
default CompletableFuture<AsyncTask>	copyTo(String dstIndexName, List<String> scope, RequestOptions requestOptions)	Copy an existing index
default CompletableFuture<AsyncTask>	delete()	Deletes the index
default CompletableFuture<AsyncTask>	delete(RequestOptions requestOptions)	Deletes the index
default CompletableFuture<AsyncTask>	moveTo(String dstIndexName)	Moves an existing index
default CompletableFuture<AsyncTask>	moveTo(String dstIndexName, RequestOptions requestOptions)	Moves an existing index

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Methods inherited from interface com.algolia.search.AsyncBaseIndex

getApiClient

Method Detail

moveTo

default CompletableFuture<AsyncTask> moveTo(@Nonnull
                                            String dstIndexName)

Moves an existing index

Parameters:

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

Returns:

The associated task

moveTo

default CompletableFuture<AsyncTask> moveTo(@Nonnull
                                            String dstIndexName,
                                            @Nonnull
                                            RequestOptions requestOptions)

Moves an existing index

Parameters:

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

requestOptions - Options to pass to this request

Returns:

The associated task

copyTo

default CompletableFuture<AsyncTask> copyTo(@Nonnull
                                            String dstIndexName)

Copy an existing index

Parameters:

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

Returns:

The associated task

copyTo

default CompletableFuture<AsyncTask> copyTo(@Nonnull
                                            String dstIndexName,
                                            @Nonnull
                                            RequestOptions requestOptions)

Copy an existing index

Parameters:

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

requestOptions - Options to pass to this request

Returns:

The associated task

copyTo

default CompletableFuture<AsyncTask> copyTo(@Nonnull
                                            String dstIndexName,
                                            @Nonnull
                                            List<String> scope,
                                            @Nonnull
                                            RequestOptions requestOptions)

Copy an existing index

Parameters:

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

scope - the list of scope to copy

requestOptions - Options to pass to this request

Returns:

The associated task

copyTo

default CompletableFuture<AsyncTask> copyTo(@Nonnull
                                            String dstIndexName,
                                            @Nonnull
                                            List<String> scope)

Copy an existing index

Parameters:

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

scope - the list of scope to copy

Returns:

The task associated

delete

default CompletableFuture<AsyncTask> delete()

Deletes the index

Returns:

the associated AsyncTask

delete

default CompletableFuture<AsyncTask> delete(@Nonnull
                                            RequestOptions requestOptions)

Deletes the index

Parameters:

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask

clear

default CompletableFuture<AsyncTask> clear()

Delete the index content without removing settings and index specific API keys.

Returns:

the associated AsyncTask

clear

default CompletableFuture<AsyncTask> clear(@Nonnull
                                           RequestOptions requestOptions)

Delete the index content without removing settings and index specific API keys.

Parameters:

requestOptions - Options to pass to this request

Returns:

the associated AsyncTask