Package com.algolia.search

Class DefaultAnalyticsClient

java.lang.Object

com.algolia.search.DefaultAnalyticsClient

public class DefaultAnalyticsClient
extends Object

Algolia's REST analytics client that wraps an instance of the transporter. 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

Method Summary

Modifier and Type	Method	Description
static AnalyticsClient	create(AnalyticsConfig config)	Creates a default AnalyticsClient with the given AnalyticsConfig.
static AnalyticsClient	create(String applicationID, String apiKey)	Creates a default AnalyticsClient with the given credentials.
static AnalyticsClient	create(String applicationID, String apiKey, String region)	Creates a default AnalyticsClient with the given credentials.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static AnalyticsClient create(@Nonnull
                                     String applicationID,
                                     @Nonnull
                                     String apiKey)

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

Parameters:

applicationID - The Algolia Application ID

apiKey - The Algolia API Key

Throws:

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

IllegalArgumentException - If the ApplicationID or the APIKey are empty

create

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

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

Parameters:

applicationID - The Algolia Application ID

apiKey - The Algolia API Key

region - The region of the Analytics cluster

Throws:

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

IllegalArgumentException - If the ApplicationID or the APIKey are empty

create

public static AnalyticsClient create(@Nonnull
                                     AnalyticsConfig config)

Creates a default AnalyticsClient with the given AnalyticsConfig. 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