Package com.algolia.search

Class AnalyticsClient

java.lang.Object

com.algolia.search.AnalyticsClient

All Implemented Interfaces:

Closeable, AutoCloseable

public final class AnalyticsClient
extends Object
implements Closeable

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

Method Summary

Modifier and Type	Method	Description
AddABTestResponse	addABTest(ABTest abTest)	Creates a new AB Test with provided configuration
AddABTestResponse	addABTest(ABTest abTest, RequestOptions requestOptions)	Creates a new AB Test with provided configuration
CompletableFuture<AddABTestResponse>	addABTestAsync(ABTest abTest)	Creates a new AB Test with provided configuration
CompletableFuture<AddABTestResponse>	addABTestAsync(ABTest abTest, RequestOptions requestOptions)	Creates a new AB Test with provided configuration
void	close()	Close the underlying Http Client
DeleteAbTestResponse	deleteABTest(long id)	Deletes the A/B Test and removes all associated metadata and metrics.
DeleteAbTestResponse	deleteABTest(long id, RequestOptions requestOptions)	Deletes the A/B Test and removes all associated metadata and metrics.
CompletableFuture<DeleteAbTestResponse>	deleteABTestAsync(long id)	Deletes the A/B Test and removes all associated metadata and metrics.
CompletableFuture<DeleteAbTestResponse>	deleteABTestAsync(long id, RequestOptions requestOptions)	Deletes the A/B Test and removes all associated metadata and metrics.
ABTestResponse	getABTest(long id)	Get an A/B test information and results.
ABTestResponse	getABTest(long id, RequestOptions requestOptions)	Get an A/B test information and results.
CompletableFuture<ABTestResponse>	getABTestAsync(long id)	Get an A/B test information and results.
CompletableFuture<ABTestResponse>	getABTestAsync(long id, RequestOptions requestOptions)	Get an A/B test information and results.
ABTests	getABTests()	Get an A/B test information and results.
ABTests	getABTests(int offset, int limit)	Get an A/B test information and results.
ABTests	getABTests(int offset, int limit, RequestOptions requestOptions)	Get an A/B test information and results.
ABTests	getABTests(RequestOptions requestOptions)	Get an A/B test information and results.
CompletableFuture<ABTests>	getABTestsAsync()	Get an A/B test information and results.
CompletableFuture<ABTests>	getABTestsAsync(int offset, int limit)	Get an A/B test information and results.
CompletableFuture<ABTests>	getABTestsAsync(int offset, int limit, RequestOptions requestOptions)	Get an A/B test information and results.
CompletableFuture<ABTests>	getABTestsAsync(RequestOptions requestOptions)	Get an A/B test information and results.
ConfigBase	getConfig()	Get Client's configuration
HttpTransport	getTransport()	Transport object responsible for the serialization/deserialization and the retry strategy.
StopAbTestResponse	stopABTest(long id)	Marks the A/B Test as stopped.
StopAbTestResponse	stopABTest(long id, RequestOptions requestOptions)	Marks the A/B Test as stopped.
CompletableFuture<StopAbTestResponse>	stopABTestAsync(long id)	Marks the A/B Test as stopped.
CompletableFuture<StopAbTestResponse>	stopABTestAsync(long id, RequestOptions requestOptions)	Marks the A/B Test as stopped.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsClient

public AnalyticsClient(@Nonnull
                       AnalyticsConfig config,
                       @Nonnull
                       HttpRequester httpRequester)

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

getABTests

public ABTests getABTests()

Get an A/B test information and results.

getABTests

public ABTests getABTests(RequestOptions requestOptions)

Get an A/B test information and results.

Parameters:

requestOptions - Options to pass to this request

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

getABTests

public ABTests getABTests(int offset,
                          int limit)

Get an A/B test information and results.

Parameters:

offset - Position of the starting record. Used for paging. 0 is the first record.

limit - Number of records to return. +used for paging. Limit is the size of the page.

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

getABTests

public ABTests getABTests(int offset,
                          int limit,
                          RequestOptions requestOptions)

Get an A/B test information and results.

Parameters:

offset - Position of the starting record. Used for paging. 0 is the first record.

limit - Number of records to return. +used for paging. Limit is the size of the page.

requestOptions - Options to pass to this request

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

getABTestsAsync

public CompletableFuture<ABTests> getABTestsAsync()

Get an A/B test information and results.

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

getABTestsAsync

public CompletableFuture<ABTests> getABTestsAsync(RequestOptions requestOptions)

Get an A/B test information and results.

Parameters:

requestOptions - Options to pass to this request

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

getABTestsAsync

public CompletableFuture<ABTests> getABTestsAsync(int offset,
                                                  int limit)

Get an A/B test information and results.

Parameters:

offset - Position of the starting record. Used for paging. 0 is the first record.

limit - Number of records to return. +used for paging. Limit is the size of the page.

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

getABTestsAsync

public CompletableFuture<ABTests> getABTestsAsync(int offset,
                                                  int limit,
                                                  RequestOptions requestOptions)

Get an A/B test information and results.

Parameters:

offset - Position of the starting record. Used for paging. 0 is the first record.

limit - Number of records to return. +used for paging. Limit is the size of the page.

requestOptions - Options to pass to this request

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

getABTest

public ABTestResponse getABTest(long id)

Get an A/B test information and results.

Parameters:

id - The ABTest ID

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

getABTest

public ABTestResponse getABTest(long id,
                                RequestOptions requestOptions)

Get an A/B test information and results.

Parameters:

id - The ABTest ID

requestOptions - Options to pass to this request

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

getABTestAsync

public CompletableFuture<ABTestResponse> getABTestAsync(long id)

Get an A/B test information and results.

Parameters:

id - The ABTest ID

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

getABTestAsync

public CompletableFuture<ABTestResponse> getABTestAsync(long id,
                                                        RequestOptions requestOptions)

Get an A/B test information and results.

Parameters:

id - The ABTest ID

requestOptions - Options to pass to this request

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

stopABTest

public StopAbTestResponse stopABTest(long id)

Marks the A/B Test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored

Parameters:

id - The ABTest ID

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

stopABTest

public StopAbTestResponse stopABTest(long id,
                                     RequestOptions requestOptions)

Marks the A/B Test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored

Parameters:

id - The ABTest ID

requestOptions - Options to pass to this request

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

stopABTestAsync

public CompletableFuture<StopAbTestResponse> stopABTestAsync(long id)

Marks the A/B Test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored

Parameters:

id - The ABTest ID

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

stopABTestAsync

public CompletableFuture<StopAbTestResponse> stopABTestAsync(long id,
                                                             RequestOptions requestOptions)

Marks the A/B Test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored

Parameters:

id - The ABTest ID

requestOptions - Options to pass to this request

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

deleteABTest

public DeleteAbTestResponse deleteABTest(long id)

Deletes the A/B Test and removes all associated metadata and metrics.

Parameters:

id - The ABTest ID

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

deleteABTest

public DeleteAbTestResponse deleteABTest(long id,
                                         RequestOptions requestOptions)

Deletes the A/B Test and removes all associated metadata and metrics.

Parameters:

id - The ABTest ID

requestOptions - Options to pass to this request

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

deleteABTestAsync

public CompletableFuture<DeleteAbTestResponse> deleteABTestAsync(long id)

Deletes the A/B Test and removes all associated metadata and metrics.

Parameters:

id - The ABTest ID

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

deleteABTestAsync

public CompletableFuture<DeleteAbTestResponse> deleteABTestAsync(long id,
                                                                 RequestOptions requestOptions)

Deletes the A/B Test and removes all associated metadata and metrics.

Parameters:

id - The ABTest ID

requestOptions - Options to pass to this request

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

addABTest

public AddABTestResponse addABTest(@Nonnull
                                   ABTest abTest)

Creates a new AB Test with provided configuration

Parameters:

abTest - The definition of the A/B test

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

addABTest

public AddABTestResponse addABTest(@Nonnull
                                   ABTest abTest,
                                   RequestOptions requestOptions)

Creates a new AB Test with provided configuration

Parameters:

abTest - The definition of the A/B test

requestOptions - Options to pass to this request

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

addABTestAsync

public CompletableFuture<AddABTestResponse> addABTestAsync(@Nonnull
                                                           ABTest abTest)

Creates a new AB Test with provided configuration

Parameters:

abTest - The definition of the A/B test

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

addABTestAsync

public CompletableFuture<AddABTestResponse> addABTestAsync(@Nonnull
                                                           ABTest abTest,
                                                           RequestOptions requestOptions)

Creates a new AB Test with provided configuration

Parameters:

abTest - The definition of the A/B test

requestOptions - Options to pass to this request

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