com.algolia.search

Class AccountClient

java.lang.Object

com.algolia.search.AccountClient

public final class AccountClient
extends Object

The account client performs cross indices operations This class is an helper and it doesn't hold resources.

Constructor Summary

Constructors

Constructor and Description
AccountClient()

Method Summary

Modifier and Type	Method and Description
static <T> MultiResponse	copyIndex(SearchIndex<T> sourceIndex, SearchIndex<T> destinationIndex) The method copy settings, synonyms, rules and objects from the source index to the destination index
static <T> MultiResponse	copyIndex(SearchIndex<T> sourceIndex, SearchIndex<T> destinationIndex, RequestOptions requestOptions) The method copy settings, synonyms, rules and objects from the source index to the destination index
static <T> CompletableFuture<MultiResponse>	copyIndexAsync(SearchIndex<T> sourceIndex, SearchIndex<T> destinationIndex) The method copy settings, synonyms, rules and objects from the source index to the destination index
static <T> CompletableFuture<MultiResponse>	copyIndexAsync(SearchIndex<T> sourceIndex, SearchIndex<T> destinationIndex, RequestOptions requestOptions) The method copy settings, synonyms, rules and objects from the source index to the destination index

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccountClient

public AccountClient()

Method Detail

copyIndex

public static <T> MultiResponse copyIndex(@Nonnull
                                          SearchIndex<T> sourceIndex,
                                          @Nonnull
                                          SearchIndex<T> destinationIndex)

The method copy settings, synonyms, rules and objects from the source index to the destination index

Parameters:

sourceIndex - The source index to copy

destinationIndex - The destination index

Throws:

AlgoliaRuntimeException - If destination index already exist or source and destination are on the same application

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

copyIndex

public static <T> MultiResponse copyIndex(@Nonnull
                                          SearchIndex<T> sourceIndex,
                                          @Nonnull
                                          SearchIndex<T> destinationIndex,
                                          RequestOptions requestOptions)

The method copy settings, synonyms, rules and objects from the source index to the destination index

Parameters:

sourceIndex - The source index to copy

destinationIndex - The destination index

requestOptions - Request options to pass to the request

Throws:

AlgoliaRuntimeException - If destination index already exist or source and destination are on the same application

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

copyIndexAsync

public static <T> CompletableFuture<MultiResponse> copyIndexAsync(@Nonnull
                                                                  SearchIndex<T> sourceIndex,
                                                                  @Nonnull
                                                                  SearchIndex<T> destinationIndex)

The method copy settings, synonyms, rules and objects from the source index to the destination index

Parameters:

sourceIndex - The source index to copy

destinationIndex - The destination index

Throws:

AlgoliaRuntimeException - If destination index already exist or source and destination are on the same application

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

copyIndexAsync

public static <T> CompletableFuture<MultiResponse> copyIndexAsync(@Nonnull
                                                                  SearchIndex<T> sourceIndex,
                                                                  @Nonnull
                                                                  SearchIndex<T> destinationIndex,
                                                                  RequestOptions requestOptions)

The method copy settings, synonyms, rules and objects from the source index to the destination index

Parameters:

sourceIndex - The source index to copy

destinationIndex - The destination index

requestOptions - Request options to pass to the request

Throws:

AlgoliaRuntimeException - If destination index already exist or source and destination are on the same application

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code