Package com.algolia.search

Interface SearchClientPersonalization

All Superinterfaces:

SearchClientBase

All Known Implementing Classes:

SearchClient

public interface SearchClientPersonalization
extends SearchClientBase

Method Summary

Modifier and Type	Method	Description
default GetStrategyResponse	getPersonalizationStrategy()	Deprecated. Endpoint will be deprecated.
default GetStrategyResponse	getPersonalizationStrategy(RequestOptions requestOptions)	Deprecated. Endpoint will be deprecated.
default CompletableFuture<GetStrategyResponse>	getPersonalizationStrategyAsync()	Deprecated. Endpoint will be deprecated.
default CompletableFuture<GetStrategyResponse>	getPersonalizationStrategyAsync(RequestOptions requestOptions)	Deprecated. Endpoint will be deprecated.
default SetStrategyResponse	setPersonalizationStrategy(SetStrategyRequest request)	Deprecated. Endpoint will be deprecated.
default SetStrategyResponse	setPersonalizationStrategy(SetStrategyRequest request, RequestOptions requestOptions)	Deprecated. Endpoint will be deprecated.
default CompletableFuture<SetStrategyResponse>	setPersonalizationStrategyAsync(SetStrategyRequest request)	Deprecated. Endpoint will be deprecated.
default CompletableFuture<SetStrategyResponse>	setPersonalizationStrategyAsync(SetStrategyRequest request, RequestOptions requestOptions)	Deprecated. Endpoint will be deprecated.

Methods inherited from interface com.algolia.search.SearchClientBase

getConfig, getTransport, waitAppTask, waitAppTask, waitTask, waitTask

Method Detail

getPersonalizationStrategy

@Deprecated
default GetStrategyResponse getPersonalizationStrategy()

Deprecated.

Endpoint will be deprecated. Please use PersonalizationConfig instead.

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

@Deprecated
default GetStrategyResponse getPersonalizationStrategy(RequestOptions requestOptions)

Deprecated.

Endpoint will be deprecated. Please use PersonalizationConfig instead.

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

@Deprecated
default CompletableFuture<GetStrategyResponse> getPersonalizationStrategyAsync()

Deprecated.

Endpoint will be deprecated. Please use PersonalizationConfig instead.

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

@Deprecated
default CompletableFuture<GetStrategyResponse> getPersonalizationStrategyAsync(RequestOptions requestOptions)

Deprecated.

Endpoint will be deprecated. Please use PersonalizationConfig instead.

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

@Deprecated
default SetStrategyResponse setPersonalizationStrategy(@Nonnull
                                                       SetStrategyRequest request)

Deprecated.

Endpoint will be deprecated. Please use PersonalizationConfig instead.

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

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

Deprecated.

Endpoint will be deprecated. Please use PersonalizationConfig instead.

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

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

Deprecated.

Endpoint will be deprecated. Please use PersonalizationConfig instead.

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

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

Deprecated.

Endpoint will be deprecated. Please use PersonalizationConfig instead.

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