Package com.algolia.search

Class DefaultInsightsClient

java.lang.Object

com.algolia.search.DefaultInsightsClient

public class DefaultInsightsClient
extends Object

Algolia's REST insights 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

Constructor Summary

Constructors

Constructor	Description
DefaultInsightsClient()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultInsightsClient

public DefaultInsightsClient()

Method Detail

create

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

Creates a default InsightsClient 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 InsightsClient create(@Nonnull
                                    InsightsConfig config)

Creates a default InsightsClient with the given InsightsConfig. 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