Package com.algolia.search

Interface SyncIndexCRUD<T>

All Superinterfaces:

AbstractIndex<T>, Serializable, SyncBaseIndex<T>

All Known Implementing Classes:

Index

public interface SyncIndexCRUD<T>
extends SyncBaseIndex<T>

Method Summary

Modifier and Type	Method	Description
default Task	clear()	Delete the index content without removing settings and index specific API keys.
default Task	clear(RequestOptions requestOptions)	Delete the index content without removing settings and index specific API keys.
default Task	copyTo(String dstIndexName)	Copy an existing index
default Task	copyTo(String dstIndexName, RequestOptions requestOptions)	Copy an existing index
default Task	copyTo(String dstIndexName, List<String> scope)	Copy an existing index
default Task	copyTo(String dstIndexName, List<String> scope, RequestOptions requestOptions)	Copy an existing index
default Task	delete()	Deletes the index
default Task	delete(RequestOptions requestOptions)	Deletes the index
default Task	moveTo(String dstIndexName)	Moves an existing index
default Task	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.SyncBaseIndex

getApiClient

Method Detail

delete

default Task delete()
             throws AlgoliaException

Deletes the index

Returns:

the associated Task

Throws:

AlgoliaException

delete

default Task delete(@Nonnull
                    RequestOptions requestOptions)
             throws AlgoliaException

Deletes the index

Parameters:

requestOptions - Options to pass to this request

Returns:

the associated Task

Throws:

AlgoliaException

clear

default Task clear()
            throws AlgoliaException

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

Returns:

the associated Task

Throws:

AlgoliaException

clear

default Task clear(@Nonnull
                   RequestOptions requestOptions)
            throws AlgoliaException

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

Parameters:

requestOptions - Options to pass to this request

Returns:

the associated Task

Throws:

AlgoliaException

moveTo

default Task moveTo(@Nonnull
                    String dstIndexName)
             throws AlgoliaException

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

Throws:

AlgoliaException

moveTo

default Task moveTo(@Nonnull
                    String dstIndexName,
                    @Nonnull
                    RequestOptions requestOptions)
             throws AlgoliaException

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

Throws:

AlgoliaException

copyTo

default Task copyTo(@Nonnull
                    String dstIndexName)
             throws AlgoliaException

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

Throws:

AlgoliaException

copyTo

default Task copyTo(@Nonnull
                    String dstIndexName,
                    @Nonnull
                    RequestOptions requestOptions)
             throws AlgoliaException

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

Throws:

AlgoliaException

copyTo

default Task copyTo(@Nonnull
                    String dstIndexName,
                    @Nonnull
                    List<String> scope,
                    @Nonnull
                    RequestOptions requestOptions)
             throws AlgoliaException

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

Throws:

AlgoliaException

copyTo

default Task copyTo(@Nonnull
                    String dstIndexName,
                    @Nonnull
                    List<String> scope)
             throws AlgoliaException

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

Throws:

AlgoliaException