com.algolia.search

Interface SearchClientMcm

All Superinterfaces:

SearchClientBase

All Known Implementing Classes:

SearchClient

public interface SearchClientMcm
extends SearchClientBase

Method Summary

Modifier and Type	Method and Description
default AssignUserIdResponse	assignUserID(String userId, String clusterName) Assign or Move a userID to a cluster.
default AssignUserIdResponse	assignUserID(String userId, String clusterName, RequestOptions requestOptions) Assign or Move a userID to a cluster.
default CompletableFuture<AssignUserIdResponse>	assignUserIDAsync(String userId, String clusterName) Assign or Move a userID to a cluster.
default CompletableFuture<AssignUserIdResponse>	assignUserIDAsync(String userId, String clusterName, RequestOptions requestOptions) Assign or Move a userID to a cluster.
default TopUserIdResponse	getTopUserID() Get the top 10 userIDs with the highest number of records per cluster.
default TopUserIdResponse	getTopUserID(RequestOptions requestOptions) Get the top 10 userIDs with the highest number of records per cluster.
default CompletableFuture<TopUserIdResponse>	getTopUserIDAsync() Get the top 10 userIDs with the highest number of records per cluster.
default CompletableFuture<TopUserIdResponse>	getTopUserIDAsync(RequestOptions requestOptions) Get the top 10 userIDs with the highest number of records per cluster.
default UserId	getUserID(String userID) Returns the userID data stored in the mapping.
default UserId	getUserID(String userID, RequestOptions requestOptions) Returns the userID data stored in the mapping.
default CompletableFuture<UserId>	getUserIDAsync(String userID) Returns the userID data stored in the mapping.
default CompletableFuture<UserId>	getUserIDAsync(String userID, RequestOptions requestOptions) Returns the userID data stored in the mapping.
default ListClustersResponse	listClusters() List the clusters available in a multi-clusters setup for a single appID
default ListClustersResponse	listClusters(RequestOptions requestOptions) List the clusters available in a multi-clusters setup for a single appID
default CompletableFuture<ListClustersResponse>	listClustersAsync() List the clusters available in a multi-clusters setup for a single appID
default CompletableFuture<ListClustersResponse>	listClustersAsync(RequestOptions requestOptions) List the clusters available in a multi-clusters setup for a single appID
default ListUserIdsResponse	listUserIDs() List the userIDs assigned to a multi-clusters appID.
default ListUserIdsResponse	listUserIDs(int page, int hitsPerPage, RequestOptions requestOptions) List the userIDs assigned to a multi-clusters appID.
default ListUserIdsResponse	listUserIDs(RequestOptions requestOptions) List the userIDs assigned to a multi-clusters appID.
default CompletableFuture<ListUserIdsResponse>	listUserIDsAsync() List the userIDs assigned to a multi-clusters appID.
default CompletableFuture<ListUserIdsResponse>	listUserIDsAsync(int page, int hitsPerPage, RequestOptions requestOptions) List the userIDs assigned to a multi-clusters appID.
default CompletableFuture<ListUserIdsResponse>	listUserIDsAsync(RequestOptions requestOptions) List the userIDs assigned to a multi-clusters appID.
default RemoveUserIdResponse	removeUserID(String userId) Remove a userID and its associated data from the multi-clusters
default RemoveUserIdResponse	removeUserID(String userId, RequestOptions requestOptions) Remove a userID and its associated data from the multi-clusters.
default CompletableFuture<RemoveUserIdResponse>	removeUserIDAsync(String userId) Remove a userID and its associated data from the multi-clusters.
default CompletableFuture<RemoveUserIdResponse>	removeUserIDAsync(String userId, RequestOptions requestOptions) Remove a userID and its associated data from the multi-clusters.
default SearchResult<UserId>	searchUserIDs(SearchUserIdsRequest query) Search for userIDs The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds propagate to the different cluster
default SearchResult<UserId>	searchUserIDs(SearchUserIdsRequest query, RequestOptions requestOptions) Search for userIDs The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds propagate to the different cluster
default CompletableFuture<SearchResult<UserId>>	searchUserIDsAsync(SearchUserIdsRequest query) Search for userIDs The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds propagate to the different cluster
default CompletableFuture<SearchResult<UserId>>	searchUserIDsAsync(SearchUserIdsRequest query, RequestOptions requestOptions) Search for userIDs The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds propagate to the different cluster

Methods inherited from interface com.algolia.search.SearchClientBase

getConfig, getTransport, waitTask, waitTask

Method Detail

listClusters

default ListClustersResponse listClusters()

List the clusters available in a multi-clusters setup for a single appID

listClusters

default ListClustersResponse listClusters(RequestOptions requestOptions)

List the clusters available in a multi-clusters setup for a single appID

Parameters:

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

listClustersAsync

default CompletableFuture<ListClustersResponse> listClustersAsync()

List the clusters available in a multi-clusters setup for a single appID

listClustersAsync

default CompletableFuture<ListClustersResponse> listClustersAsync(RequestOptions requestOptions)

List the clusters available in a multi-clusters setup for a single appID

Parameters:

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

searchUserIDs

default SearchResult<UserId> searchUserIDs(@Nonnull
                                           SearchUserIdsRequest query)

Search for userIDs The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds propagate to the different cluster

Parameters:

query - The query to search for userIDs

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

searchUserIDs

default SearchResult<UserId> searchUserIDs(@Nonnull
                                           SearchUserIdsRequest query,
                                           RequestOptions requestOptions)

Search for userIDs The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds propagate to the different cluster

Parameters:

query - The query to search for userIDs

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

searchUserIDsAsync

default CompletableFuture<SearchResult<UserId>> searchUserIDsAsync(@Nonnull
                                                                   SearchUserIdsRequest query)

Search for userIDs The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds propagate to the different cluster

Parameters:

query - The query to search for userIDs

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

searchUserIDsAsync

default CompletableFuture<SearchResult<UserId>> searchUserIDsAsync(@Nonnull
                                                                   SearchUserIdsRequest query,
                                                                   RequestOptions requestOptions)

Search for userIDs The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds propagate to the different cluster

Parameters:

query - The query to search for userIDs

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

listUserIDs

default ListUserIdsResponse listUserIDs()

List the userIDs assigned to a multi-clusters appID.

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

listUserIDs

default ListUserIdsResponse listUserIDs(int page,
                                        int hitsPerPage,
                                        RequestOptions requestOptions)

List the userIDs assigned to a multi-clusters appID.

Parameters:

page - The page number to request

hitsPerPage - Number of hits per page

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

listUserIDs

default ListUserIdsResponse listUserIDs(RequestOptions requestOptions)

List the userIDs assigned to a multi-clusters appID.

Parameters:

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

listUserIDsAsync

default CompletableFuture<ListUserIdsResponse> listUserIDsAsync()

List the userIDs assigned to a multi-clusters appID.

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

listUserIDsAsync

default CompletableFuture<ListUserIdsResponse> listUserIDsAsync(int page,
                                                                int hitsPerPage,
                                                                RequestOptions requestOptions)

List the userIDs assigned to a multi-clusters appID.

Parameters:

page - The page number to request

hitsPerPage - Number of hits per page

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

listUserIDsAsync

default CompletableFuture<ListUserIdsResponse> listUserIDsAsync(RequestOptions requestOptions)

List the userIDs assigned to a multi-clusters appID.

Parameters:

requestOptions - Options to pass to this request

getUserID

default UserId getUserID(@Nonnull
                         String userID)

Returns the userID data stored in the mapping.

Parameters:

userID - The userID in the mapping

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

getUserID

default UserId getUserID(@Nonnull
                         String userID,
                         RequestOptions requestOptions)

Returns the userID data stored in the mapping.

Parameters:

userID - The userID in the mapping

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

getUserIDAsync

default CompletableFuture<UserId> getUserIDAsync(@Nonnull
                                                 String userID)

Returns the userID data stored in the mapping.

Parameters:

userID - The userID in the mapping

getUserIDAsync

default CompletableFuture<UserId> getUserIDAsync(@Nonnull
                                                 String userID,
                                                 RequestOptions requestOptions)

Returns the userID data stored in the mapping.

Parameters:

userID - The userID in the mapping

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

getTopUserID

default TopUserIdResponse getTopUserID()

Get the top 10 userIDs with the highest number of records per cluster. The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds to propagate to the different clusters.

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

getTopUserID

default TopUserIdResponse getTopUserID(RequestOptions requestOptions)

Get the top 10 userIDs with the highest number of records per cluster. The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds to propagate to the different clusters.

Parameters:

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

getTopUserIDAsync

default CompletableFuture<TopUserIdResponse> getTopUserIDAsync()

Get the top 10 userIDs with the highest number of records per cluster. The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds to propagate to the different clusters.

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

getTopUserIDAsync

default CompletableFuture<TopUserIdResponse> getTopUserIDAsync(RequestOptions requestOptions)

Get the top 10 userIDs with the highest number of records per cluster. The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds to propagate to the different clusters.

Parameters:

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

removeUserID

default RemoveUserIdResponse removeUserID(@Nonnull
                                          String userId)

Remove a userID and its associated data from the multi-clusters

Parameters:

userId - The userID to remove

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

removeUserID

default RemoveUserIdResponse removeUserID(@Nonnull
                                          String userId,
                                          RequestOptions requestOptions)

Remove a userID and its associated data from the multi-clusters.

Parameters:

userId - userID

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

removeUserIDAsync

default CompletableFuture<RemoveUserIdResponse> removeUserIDAsync(@Nonnull
                                                                  String userId)

Remove a userID and its associated data from the multi-clusters.

Parameters:

userId - userID

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

removeUserIDAsync

default CompletableFuture<RemoveUserIdResponse> removeUserIDAsync(@Nonnull
                                                                  String userId,
                                                                  RequestOptions requestOptions)

Remove a userID and its associated data from the multi-clusters.

Parameters:

userId - userID

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

assignUserID

default AssignUserIdResponse assignUserID(@Nonnull
                                          String userId,
                                          @Nonnull
                                          String clusterName)

Assign or Move a userID to a cluster. The time it takes to migrate (move) a user is proportional to the amount of data linked to the userID.

Parameters:

userId - The userID

clusterName - The name of the cluster

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

assignUserID

default AssignUserIdResponse assignUserID(@Nonnull
                                          String userId,
                                          @Nonnull
                                          String clusterName,
                                          RequestOptions requestOptions)

Assign or Move a userID to a cluster. The time it takes to migrate (move) a user is proportional to the amount of data linked to the userID.

Parameters:

userId - The userID

clusterName - The name of the cluster

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

assignUserIDAsync

default CompletableFuture<AssignUserIdResponse> assignUserIDAsync(@Nonnull
                                                                  String userId,
                                                                  @Nonnull
                                                                  String clusterName)

Assign or Move a userID to a cluster. The time it takes to migrate (move) a user is proportional to the amount of data linked to the userID.

Parameters:

userId - The userID

clusterName - The name of the cluster

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

assignUserIDAsync

default CompletableFuture<AssignUserIdResponse> assignUserIDAsync(@Nonnull
                                                                  String userId,
                                                                  @Nonnull
                                                                  String clusterName,
                                                                  RequestOptions requestOptions)

Assign or Move a userID to a cluster. The time it takes to migrate (move) a user is proportional to the amount of data linked to the userID.

Parameters:

userId - The userID

clusterName - The name of the cluster

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