Package com.algolia.api

Class InsightsClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.InsightsClient

public class InsightsClient
extends ApiClient

Field Summary

Fields inherited from class com.algolia.ApiClient

json

Constructor Summary

Constructors

Constructor	Description
InsightsClient(String appId, String apiKey)
InsightsClient(String appId, String apiKey, ClientOptions options)
InsightsClient(String appId, String apiKey, String region)
InsightsClient(String appId, String apiKey, String region, ClientOptions options)

Method Summary

Modifier and Type	Method	Description
Object	del(String path)	This method allow you to send requests to the Algolia REST API.
Object	del(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	del(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	del(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	get(String path)	This method allow you to send requests to the Algolia REST API.
Object	get(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	get(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	get(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	post(String path)	This method allow you to send requests to the Algolia REST API.
Object	post(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	post(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	post(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
EventsResponse	pushEvents(InsightsEvents insightsEvents)	Send a list of events to the Insights API.
EventsResponse	pushEvents(InsightsEvents insightsEvents, RequestOptions requestOptions)	Send a list of events to the Insights API.
CompletableFuture<EventsResponse>	pushEventsAsync(InsightsEvents insightsEvents)	(asynchronously) Send a list of events to the Insights API.
CompletableFuture<EventsResponse>	pushEventsAsync(InsightsEvents insightsEvents, RequestOptions requestOptions)	(asynchronously) Send a list of events to the Insights API.
Object	put(String path)	This method allow you to send requests to the Algolia REST API.
Object	put(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	put(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	put(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.

Methods inherited from class com.algolia.ApiClient

addAlgoliaAgent, addDefaultHeader, buildCall, buildRequest, buildUrl, escapeString, executeAsync, executeAsync, executeAsync, getConnectTimeout, getReadTimeout, getWriteTimeout, isDebugging, parameterToString, processHeaderParams, removeAlgoliaAgent, serialize, setConnectTimeout, setHosts, setLogLevel, setReadTimeout, setWriteTimeout

Methods inherited from class java.lang.Object

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

Constructor Details

InsightsClient

public InsightsClient(String appId,
 String apiKey)

InsightsClient

public InsightsClient(String appId,
 String apiKey,
 ClientOptions options)

InsightsClient

public InsightsClient(String appId,
 String apiKey,
 String region)

InsightsClient

public InsightsClient(String appId,
 String apiKey,
 String region,
 ClientOptions options)

Method Details

del

public Object del(String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(String path,
 Map<String,Object> parameters)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(String path,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(String path)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Returns:

CompletableFuture