com.algolia.search

Interface SearchClientPersonalization

All Superinterfaces:

SearchClientBase

All Known Implementing Classes:

SearchClient

public interface SearchClientPersonalization
extends SearchClientBase

Method Summary

Modifier and Type	Method and Description
default GetStrategyResponse	getPersonalizationStrategy() Returns the personalization strategy of the application
default GetStrategyResponse	getPersonalizationStrategy(RequestOptions requestOptions) Returns the personalization strategy of the application
default CompletableFuture<GetStrategyResponse>	getPersonalizationStrategyAsync() Returns the personalization strategy of the application
default CompletableFuture<GetStrategyResponse>	getPersonalizationStrategyAsync(RequestOptions requestOptions) Returns the personalization strategy of the application
default SetStrategyResponse	setPersonalizationStrategy(SetStrategyRequest request) This command configures the personalization strategy
default SetStrategyResponse	setPersonalizationStrategy(SetStrategyRequest request, RequestOptions requestOptions) This command configures the personalization strategy
default CompletableFuture<SetStrategyResponse>	setPersonalizationStrategyAsync(SetStrategyRequest request) This command configures the personalization strategy
default CompletableFuture<SetStrategyResponse>	setPersonalizationStrategyAsync(SetStrategyRequest request, RequestOptions requestOptions) This command configures the personalization strategy

Methods inherited from interface com.algolia.search.SearchClientBase

getConfig, getTransport, waitTask, waitTask

Method Detail

getPersonalizationStrategy

default GetStrategyResponse getPersonalizationStrategy()

Returns the personalization strategy of the application

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

getPersonalizationStrategy

default GetStrategyResponse getPersonalizationStrategy(RequestOptions requestOptions)

Returns the personalization strategy of the application

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

getPersonalizationStrategyAsync

default CompletableFuture<GetStrategyResponse> getPersonalizationStrategyAsync()

Returns the personalization strategy of the application

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

getPersonalizationStrategyAsync

default CompletableFuture<GetStrategyResponse> getPersonalizationStrategyAsync(RequestOptions requestOptions)

Returns the personalization strategy of the application

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

setPersonalizationStrategy

default SetStrategyResponse setPersonalizationStrategy(@Nonnull
                                                       SetStrategyRequest request)

This command configures the personalization strategy

Parameters:

request - The personalization strategy

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

setPersonalizationStrategy

default SetStrategyResponse setPersonalizationStrategy(@Nonnull
                                                       SetStrategyRequest request,
                                                       RequestOptions requestOptions)

This command configures the personalization strategy

Parameters:

request - The personalization strategy

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

setPersonalizationStrategyAsync

default CompletableFuture<SetStrategyResponse> setPersonalizationStrategyAsync(@Nonnull
                                                                               SetStrategyRequest request)

This command configures the personalization strategy

Parameters:

request - The personalization strategy

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

setPersonalizationStrategyAsync

default CompletableFuture<SetStrategyResponse> setPersonalizationStrategyAsync(@Nonnull
                                                                               SetStrategyRequest request,
                                                                               RequestOptions requestOptions)

This command configures the personalization strategy

Parameters:

request - The personalization strategy

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