com.algolia.search

Interface SearchClientCopyOperations

All Superinterfaces:

SearchClientBase

All Known Implementing Classes:

SearchClient

public interface SearchClientCopyOperations
extends SearchClientBase

Method Summary

Modifier and Type	Method and Description
default void	checkIndicesBeforeMoving(String sourceIndex, String destinationIndex)
default CopyResponse	copyIndex(String sourceIndex, String destinationIndex) Make a copy of an index, in the given scope.
default CopyResponse	copyIndex(String sourceIndex, String destinationIndex, List<String> scopes) Make a copy of an index, in the given scope.
default CopyResponse	copyIndex(String sourceIndex, String destinationIndex, List<String> scopes, RequestOptions requestOptions) Make a copy of an index in the given scope.
default CompletableFuture<CopyResponse>	copyIndexAsync(String sourceIndex, String destinationIndex) Make a copy of an index, in the given scope.
default CompletableFuture<CopyResponse>	copyIndexAsync(String sourceIndex, String destinationIndex, List<String> scopes) Make a copy of an index, in the given scope.
default CompletableFuture<CopyResponse>	copyIndexAsync(String sourceIndex, String destinationIndex, List<String> scopes, RequestOptions requestOptions) Make a copy of an index in the given scope.
default CopyResponse	copyRules(String sourceIndex, String destinationIndex) Make a copy of the rules of an index
default CopyResponse	copyRules(String sourceIndex, String destinationIndex, RequestOptions requestOptions) Make a copy of the rules of an index
default CompletableFuture<CopyResponse>	copyRulesAsync(String sourceIndex, String destinationIndex) Make a copy of the rules of an index
default CompletableFuture<CopyResponse>	copyRulesAsync(String sourceIndex, String destinationIndex, RequestOptions requestOptions) Make a copy of the rules of an index
default CopyResponse	copySettings(String sourceIndex, String destinationIndex) Make a copy of the settings of an index
default CopyResponse	copySettings(String sourceIndex, String destinationIndex, RequestOptions requestOptions) Make a copy of the settings of an index
default CompletableFuture<CopyResponse>	copySettingsAsync(String sourceIndex, String destinationIndex) Make a copy of the settings of an index
default CompletableFuture<CopyResponse>	copySettingsAsync(String sourceIndex, String destinationIndex, RequestOptions requestOptions) Make a copy of the settings of an index
default CopyResponse	copySynonyms(String sourceIndex, String destinationIndex) Make a copy of the synonyms of an index
default CopyResponse	copySynonyms(String sourceIndex, String destinationIndex, RequestOptions requestOptions) Make a copy of the synonyms of an index
default CompletableFuture<CopyResponse>	copySynonymsAsync(String sourceIndex, String destinationIndex) Make a copy of the synonyms of an index
default CompletableFuture<CopyResponse>	copySynonymsAsync(String sourceIndex, String destinationIndex, RequestOptions requestOptions) Make a copy of the synonyms of an index
default MoveIndexResponse	moveIndex(String sourceIndex, String destinationIndex) Rename an index.
default MoveIndexResponse	moveIndex(String sourceIndex, String destinationIndex, RequestOptions requestOptions) Rename an index.
default CompletableFuture<MoveIndexResponse>	moveIndexAsync(String sourceIndex, String destinationIndex) Rename an index.
default CompletableFuture<MoveIndexResponse>	moveIndexAsync(String sourceIndex, String destinationIndex, RequestOptions requestOptions) Rename an index.

Methods inherited from interface com.algolia.search.SearchClientBase

getConfig, getTransport, waitTask, waitTask

Method Detail

copySettings

default CopyResponse copySettings(@Nonnull
                                  String sourceIndex,
                                  @Nonnull
                                  String destinationIndex)

Make a copy of the settings of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copySettings

default CopyResponse copySettings(@Nonnull
                                  String sourceIndex,
                                  @Nonnull
                                  String destinationIndex,
                                  RequestOptions requestOptions)

Make a copy of the settings of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copySettingsAsync

default CompletableFuture<CopyResponse> copySettingsAsync(@Nonnull
                                                          String sourceIndex,
                                                          @Nonnull
                                                          String destinationIndex)

Make a copy of the settings of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copySettingsAsync

default CompletableFuture<CopyResponse> copySettingsAsync(@Nonnull
                                                          String sourceIndex,
                                                          @Nonnull
                                                          String destinationIndex,
                                                          RequestOptions requestOptions)

Make a copy of the settings of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copyRules

default CopyResponse copyRules(@Nonnull
                               String sourceIndex,
                               @Nonnull
                               String destinationIndex)

Make a copy of the rules of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copyRules

default CopyResponse copyRules(@Nonnull
                               String sourceIndex,
                               @Nonnull
                               String destinationIndex,
                               RequestOptions requestOptions)

Make a copy of the rules of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copyRulesAsync

default CompletableFuture<CopyResponse> copyRulesAsync(@Nonnull
                                                       String sourceIndex,
                                                       @Nonnull
                                                       String destinationIndex)

Make a copy of the rules of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copyRulesAsync

default CompletableFuture<CopyResponse> copyRulesAsync(@Nonnull
                                                       String sourceIndex,
                                                       @Nonnull
                                                       String destinationIndex,
                                                       RequestOptions requestOptions)

Make a copy of the rules of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copySynonyms

default CopyResponse copySynonyms(@Nonnull
                                  String sourceIndex,
                                  @Nonnull
                                  String destinationIndex)

Make a copy of the synonyms of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copySynonyms

default CopyResponse copySynonyms(@Nonnull
                                  String sourceIndex,
                                  @Nonnull
                                  String destinationIndex,
                                  RequestOptions requestOptions)

Make a copy of the synonyms of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copySynonymsAsync

default CompletableFuture<CopyResponse> copySynonymsAsync(@Nonnull
                                                          String sourceIndex,
                                                          @Nonnull
                                                          String destinationIndex)

Make a copy of the synonyms of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copySynonymsAsync

default CompletableFuture<CopyResponse> copySynonymsAsync(@Nonnull
                                                          String sourceIndex,
                                                          @Nonnull
                                                          String destinationIndex,
                                                          RequestOptions requestOptions)

Make a copy of the synonyms of an index

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copyIndex

default CopyResponse copyIndex(@Nonnull
                               String sourceIndex,
                               @Nonnull
                               String destinationIndex)

Make a copy of an index, in the given scope.

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copyIndex

default CopyResponse copyIndex(@Nonnull
                               String sourceIndex,
                               @Nonnull
                               String destinationIndex,
                               List<String> scopes)

Make a copy of an index, in the given scope.

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

scopes - Scope of the copy

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copyIndex

default CopyResponse copyIndex(@Nonnull
                               String sourceIndex,
                               @Nonnull
                               String destinationIndex,
                               List<String> scopes,
                               RequestOptions requestOptions)

Make a copy of an index in the given scope.

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

scopes - Scope of the copy

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copyIndexAsync

default CompletableFuture<CopyResponse> copyIndexAsync(@Nonnull
                                                       String sourceIndex,
                                                       @Nonnull
                                                       String destinationIndex)

Make a copy of an index, in the given scope.

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copyIndexAsync

default CompletableFuture<CopyResponse> copyIndexAsync(@Nonnull
                                                       String sourceIndex,
                                                       @Nonnull
                                                       String destinationIndex,
                                                       List<String> scopes)

Make a copy of an index, in the given scope.

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

scopes - Scope of the copy

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

copyIndexAsync

default CompletableFuture<CopyResponse> copyIndexAsync(@Nonnull
                                                       String sourceIndex,
                                                       @Nonnull
                                                       String destinationIndex,
                                                       List<String> scopes,
                                                       RequestOptions requestOptions)

Make a copy of an index in the given scope.

Parameters:

sourceIndex - The source index to copy from

destinationIndex - the destination index

scopes - Scope of the copy

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

moveIndex

default MoveIndexResponse moveIndex(@Nonnull
                                    String sourceIndex,
                                    @Nonnull
                                    String destinationIndex)

Rename an index. Normally used to reindex your data atomically, without any down time.

Parameters:

sourceIndex - The source index. Should not be null or empty.

destinationIndex - The destination destination. Should not be null or empty.

moveIndex

default MoveIndexResponse moveIndex(@Nonnull
                                    String sourceIndex,
                                    @Nonnull
                                    String destinationIndex,
                                    RequestOptions requestOptions)

Rename an index. Normally used to reindex your data atomically, without any down time.

Parameters:

sourceIndex - The source index. Should not be null or empty.

destinationIndex - The destination destination. Should not be null or empty.

requestOptions - Options to pass to this request

moveIndexAsync

default CompletableFuture<MoveIndexResponse> moveIndexAsync(@Nonnull
                                                            String sourceIndex,
                                                            @Nonnull
                                                            String destinationIndex)

Rename an index. Normally used to reindex your data atomically, without any down time.

Parameters:

sourceIndex - The source index. Should not be null or empty.

destinationIndex - The destination destination. Should not be null or empty.

moveIndexAsync

default CompletableFuture<MoveIndexResponse> moveIndexAsync(@Nonnull
                                                            String sourceIndex,
                                                            @Nonnull
                                                            String destinationIndex,
                                                            RequestOptions requestOptions)

Rename an index. Normally used to reindex your data atomically, without any down time.

Parameters:

sourceIndex - The source index. Should not be null or empty.

destinationIndex - The destination destination. Should not be null or empty.

requestOptions - Options to pass to this request

checkIndicesBeforeMoving

default void checkIndicesBeforeMoving(@Nonnull
                                      String sourceIndex,
                                      @Nonnull
                                      String destinationIndex)