Package com.algolia.search

Class RecommendationClient

java.lang.Object

com.algolia.search.RecommendationClient

All Implemented Interfaces:

Closeable, AutoCloseable

@Deprecated
public class RecommendationClient
extends Object
implements Closeable

Deprecated.

use PersonalizationClient instead

Algolia's REST recommendation client that wraps an instance of the transporter HttpTransport which wraps the HTTP Client This client allows to build typed requests and read typed responses. Requests are made under the Algolia's retry-strategy. This client is intended to be reused and it's thread-safe.

See Also:

Algolia.com

Constructor Summary

Constructors

Constructor	Description
RecommendationClient(RecommendationConfig config, HttpRequester httpRequester)	Deprecated. Creates a custom RecommendationClient with the given RecommendationConfig and the given HttpRequester

Method Summary

Modifier and Type	Method	Description
void	close()	Deprecated. Close the underlying Http Client
ConfigBase	getConfig()	Deprecated. Get Client's configuration
GetStrategyResponse	getPersonalizationStrategy()	Deprecated. Returns the personalization strategy of the application
GetStrategyResponse	getPersonalizationStrategy(RequestOptions requestOptions)	Deprecated. Returns the personalization strategy of the application
CompletableFuture<GetStrategyResponse>	getPersonalizationStrategyAsync()	Deprecated. Returns the personalization strategy of the application
CompletableFuture<GetStrategyResponse>	getPersonalizationStrategyAsync(RequestOptions requestOptions)	Deprecated. Returns the personalization strategy of the application
SetStrategyResponse	setPersonalizationStrategy(SetStrategyRequest request)	Deprecated. This command configures the personalization strategy
SetStrategyResponse	setPersonalizationStrategy(SetStrategyRequest request, RequestOptions requestOptions)	Deprecated. This command configures the personalization strategy
CompletableFuture<SetStrategyResponse>	setPersonalizationStrategyAsync(SetStrategyRequest request)	Deprecated. This command configures the personalization strategy
CompletableFuture<SetStrategyResponse>	setPersonalizationStrategyAsync(SetStrategyRequest request, RequestOptions requestOptions)	Deprecated. This command configures the personalization strategy

Methods inherited from class java.lang.Object

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

Constructor Detail

RecommendationClient

public RecommendationClient(@Nonnull
                            RecommendationConfig config,
                            @Nonnull
                            HttpRequester httpRequester)

Deprecated.

Creates a custom RecommendationClient with the given RecommendationConfig and the given HttpRequester

Parameters:

config - The configuration allows you to advanced configuration of the clients such as batch size or custom hosts and timeout.

httpRequester - Another HTTP Client than the default one. Must be an implementation of HttpRequester.

Throws:

NullPointerException - If one of the following ApplicationID/ApiKey/Configuration/Requester is null

IllegalArgumentException - If the ApplicationID or the APIKey are empty

Method Detail

close

public void close()
           throws IOException

Deprecated.

Close the underlying Http Client

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if an I/O error occurs

getPersonalizationStrategy

public GetStrategyResponse getPersonalizationStrategy()

Deprecated.

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

public GetStrategyResponse getPersonalizationStrategy(RequestOptions requestOptions)

Deprecated.

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

public CompletableFuture<GetStrategyResponse> getPersonalizationStrategyAsync()

Deprecated.

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

public CompletableFuture<GetStrategyResponse> getPersonalizationStrategyAsync(RequestOptions requestOptions)

Deprecated.

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

public SetStrategyResponse setPersonalizationStrategy(@Nonnull
                                                      SetStrategyRequest request)

Deprecated.

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

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

Deprecated.

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

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

Deprecated.

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

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

Deprecated.

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

getConfig

public ConfigBase getConfig()

Deprecated.

Get Client's configuration