Package com.algolia.search

Class DefaultSearchClient

java.lang.Object

com.algolia.search.DefaultSearchClient

public class DefaultSearchClient
extends Object

Algolia's REST search client that wraps an instance of the transporter which wraps the HttpClient 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
DefaultSearchClient()

Method Summary

Modifier and Type	Method	Description
static SearchClient	create(SearchConfig config)	Creates a default DefaultSearchClient with the given SearchConfig.
static SearchClient	create(String applicationID, String apiKey)	Creates a DefaultSearchClient 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

DefaultSearchClient

public DefaultSearchClient()

Method Detail

create

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

Creates a DefaultSearchClient 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 SearchClient create(@Nonnull
                                  SearchConfig config)

Creates a default DefaultSearchClient 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