com.algolia.search

Class AsyncInsightsClient

java.lang.Object

com.algolia.search.AsyncInsightsClient

public class AsyncInsightsClient
extends Object

Constructor Summary

Constructors

Constructor and Description
AsyncInsightsClient(InsightsConfig config, AsyncAPIClient client)
AsyncInsightsClient(String applicationId, String apiKey, AsyncAPIClient client)
AsyncInsightsClient(String applicationId, String apiKey, String region, AsyncAPIClient client)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<InsightsResult>	sendEvent(InsightsEvent event) This command pushes an event to the Insights API.
CompletableFuture<InsightsResult>	sendEvent(InsightsEvent event, RequestOptions requestOptions) This command pushes an event to the Insights API.
CompletableFuture<InsightsResult>	sendEvents(List<InsightsEvent> events) This command pushes an array of events to the Insights API.
CompletableFuture<InsightsResult>	sendEvents(List<InsightsEvent> events, RequestOptions requestOptions) This command pushes an array of events to the Insights API.
AsyncUserInsightsClient	user(String userToken)

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncInsightsClient

public AsyncInsightsClient(@Nonnull
                           String applicationId,
                           @Nonnull
                           String apiKey,
                           @Nonnull
                           AsyncAPIClient client)

Parameters:

applicationId - The application ID

apiKey - The API Key

client - API Client

AsyncInsightsClient

public AsyncInsightsClient(@Nonnull
                           String applicationId,
                           @Nonnull
                           String apiKey,
                           @Nonnull
                           String region,
                           @Nonnull
                           AsyncAPIClient client)

Parameters:

applicationId - The applicationID

apiKey - The api KEY

region - The server region

client - APIClient

AsyncInsightsClient

public AsyncInsightsClient(@Nonnull
                           InsightsConfig config,
                           @Nonnull
                           AsyncAPIClient client)

Parameters:

config - InsightsClient

client - APIClient

Method Detail

user

public AsyncUserInsightsClient user(@Nonnull
                                    String userToken)

Parameters:

userToken - the user config

sendEvent

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

This command pushes an event to the Insights API.

Parameters:

event - An event

sendEvent

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

This command pushes an event to the Insights API.

Parameters:

event - An event

requestOptions - RequestOptions

sendEvents

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

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

Parameters:

events - List of events

sendEvents

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

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

Parameters:

events - List of events

requestOptions - RequestOptions