Package com.algolia.search

Class DefaultRecommendationClient

java.lang.Object

com.algolia.search.DefaultRecommendationClient

public class DefaultRecommendationClient
extends Object

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
DefaultRecommendationClient()

Method Summary

Modifier and Type	Method	Description
static RecommendationClient	create(RecommendationConfig config)	Creates a default RecommendationClient with the given SearchConfig.
static RecommendationClient	create(String applicationID, String apiKey, String region)	Creates a RecommendationClient with the given credentials The default HttpClient implementation is ApacheHttpRequester

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRecommendationClient

public DefaultRecommendationClient()

Method Detail

create

public static RecommendationClient create(@Nonnull
                                          String applicationID,
                                          @Nonnull
                                          String apiKey,
                                          @Nonnull
                                          String region)

Creates a RecommendationClient with the given credentials The default HttpClient implementation is ApacheHttpRequester

Parameters:

applicationID - The Algolia Application ID

apiKey - The Algolia API Key

region - Region where your personalization data is stored and processed.

Throws:

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

IllegalArgumentException - If the ApplicationID or the APIKey are empty

create

public static RecommendationClient create(@Nonnull
                                          RecommendationConfig config)

Creates a default RecommendationClient with the given SearchConfig. The default HttpClient implementation is ApacheHttpRequester

Parameters:

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

Throws:

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

IllegalArgumentException - If the ApplicationID or the APIKey are empty