Package com.algolia.search

Class InsightsClient

java.lang.Object

com.algolia.search.InsightsClient

All Implemented Interfaces:

Closeable, AutoCloseable

public final class InsightsClient
extends Object
implements Closeable

Algolia's REST insights 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
InsightsClient(InsightsConfig config, HttpRequester httpRequester)	Creates a custom InsightsClient with the given InsightsConfig and the given HttpRequester

Method Summary

Modifier and Type	Method	Description
void	close()	Close the underlying Http Client
ConfigBase	getConfig()	Get Client's configuration
HttpTransport	getTransport()	Transport object responsible for the serialization/deserialization and the retry strategy.
InsightsResult	sendEvent(InsightsEvent event)	This command pushes an event to the Insights API.
InsightsResult	sendEvent(InsightsEvent event, RequestOptions requestOptions)	This command pushes an event to the Insights API.
CompletableFuture<InsightsResult>	sendEventAsync(InsightsEvent event)	This command pushes an event to the Insights API.
CompletableFuture<InsightsResult>	sendEventAsync(InsightsEvent event, RequestOptions requestOptions)	This command pushes an event to the Insights API.
InsightsResult	sendEvents(List<InsightsEvent> events)	This command pushes an array of events to the Insights API.
InsightsResult	sendEvents(List<InsightsEvent> events, RequestOptions requestOptions)	This command pushes an array of events to the Insights API.
CompletableFuture<InsightsResult>	sendEventsAsync(List<InsightsEvent> events)	This command pushes an array of events to the Insights API.
CompletableFuture<InsightsResult>	sendEventsAsync(List<InsightsEvent> events, RequestOptions requestOptions)	This command pushes an array of events to the Insights API.
UserInsightsClient	user(String userToken)

Methods inherited from class java.lang.Object

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

Constructor Detail

InsightsClient

public InsightsClient(@Nonnull
                      InsightsConfig config,
                      @Nonnull
                      HttpRequester httpRequester)

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

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

getConfig

public ConfigBase getConfig()

Get Client's configuration

getTransport

public HttpTransport getTransport()

Transport object responsible for the serialization/deserialization and the retry strategy.

user

public UserInsightsClient user(@Nonnull
                               String userToken)

Parameters:

userToken - the user config

sendEvent

public InsightsResult sendEvent(@Nonnull
                                InsightsEvent event)

This command pushes an event to the Insights API.

Parameters:

event - An event

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

sendEvent

public InsightsResult sendEvent(@Nonnull
                                InsightsEvent event,
                                RequestOptions requestOptions)

This command pushes an event to the Insights API.

Parameters:

event - An event

requestOptions - RequestOptions

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

sendEventAsync

public CompletableFuture<InsightsResult> sendEventAsync(@Nonnull
                                                        InsightsEvent event)

This command pushes an event to the Insights API.

Parameters:

event - An event

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

sendEventAsync

public CompletableFuture<InsightsResult> sendEventAsync(@Nonnull
                                                        InsightsEvent event,
                                                        RequestOptions requestOptions)

This command pushes an event to the Insights API.

Parameters:

event - An event

requestOptions - RequestOptions

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

sendEvents

public InsightsResult sendEvents(@Nonnull
                                 List<InsightsEvent> events)

This command pushes an array of events to the Insights API.

Parameters:

events - List of events

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

sendEvents

public InsightsResult sendEvents(@Nonnull
                                 List<InsightsEvent> events,
                                 RequestOptions requestOptions)

This command pushes an array of events to the Insights API.

Parameters:

events - List of events

requestOptions - RequestOptions

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

sendEventsAsync

public CompletableFuture<InsightsResult> sendEventsAsync(@Nonnull
                                                         List<InsightsEvent> events)

This command pushes an array of events to the Insights API.

Parameters:

events - List of events

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

sendEventsAsync

public CompletableFuture<InsightsResult> sendEventsAsync(@Nonnull
                                                         List<InsightsEvent> events,
                                                         RequestOptions requestOptions)

This command pushes an array of events to the Insights API.

Parameters:

events - List of events

requestOptions - RequestOptions

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