Package com.algolia.api

Class MonitoringClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.MonitoringClient

public class MonitoringClient
extends ApiClient

Field Summary

Fields inherited from class com.algolia.ApiClient

json

Constructor Summary

Constructors

Constructor	Description
MonitoringClient(String appId, String apiKey)
MonitoringClient(String appId, String apiKey, 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.
IncidentsResponse	getClusterIncidents(String clusters)	List known incidents for selected clusters.
IncidentsResponse	getClusterIncidents(String clusters, RequestOptions requestOptions)	List known incidents for selected clusters.
CompletableFuture<IncidentsResponse>	getClusterIncidentsAsync(String clusters)	(asynchronously) List known incidents for selected clusters.
CompletableFuture<IncidentsResponse>	getClusterIncidentsAsync(String clusters, RequestOptions requestOptions)	(asynchronously) List known incidents for selected clusters.
StatusResponse	getClusterStatus(String clusters)	Report whether a cluster is operational.
StatusResponse	getClusterStatus(String clusters, RequestOptions requestOptions)	Report whether a cluster is operational.
CompletableFuture<StatusResponse>	getClusterStatusAsync(String clusters)	(asynchronously) Report whether a cluster is operational.
CompletableFuture<StatusResponse>	getClusterStatusAsync(String clusters, RequestOptions requestOptions)	(asynchronously) Report whether a cluster is operational.
IncidentsResponse	getIncidents()	List known incidents for all clusters.
IncidentsResponse	getIncidents(RequestOptions requestOptions)	List known incidents for all clusters.
CompletableFuture<IncidentsResponse>	getIncidentsAsync()	(asynchronously) List known incidents for all clusters.
CompletableFuture<IncidentsResponse>	getIncidentsAsync(RequestOptions requestOptions)	(asynchronously) List known incidents for all clusters.
IndexingTimeResponse	getIndexingTime(String clusters)	List the average times for indexing operations for selected clusters.
IndexingTimeResponse	getIndexingTime(String clusters, RequestOptions requestOptions)	List the average times for indexing operations for selected clusters.
CompletableFuture<IndexingTimeResponse>	getIndexingTimeAsync(String clusters)	(asynchronously) List the average times for indexing operations for selected clusters.
CompletableFuture<IndexingTimeResponse>	getIndexingTimeAsync(String clusters, RequestOptions requestOptions)	(asynchronously) List the average times for indexing operations for selected clusters.
InventoryResponse	getInventory()	List the servers belonging to clusters.
InventoryResponse	getInventory(RequestOptions requestOptions)	List the servers belonging to clusters.
CompletableFuture<InventoryResponse>	getInventoryAsync()	(asynchronously) List the servers belonging to clusters.
CompletableFuture<InventoryResponse>	getInventoryAsync(RequestOptions requestOptions)	(asynchronously) List the servers belonging to clusters.
LatencyResponse	getLatency(String clusters)	List the average latency for search requests for selected clusters.
LatencyResponse	getLatency(String clusters, RequestOptions requestOptions)	List the average latency for search requests for selected clusters.
CompletableFuture<LatencyResponse>	getLatencyAsync(String clusters)	(asynchronously) List the average latency for search requests for selected clusters.
CompletableFuture<LatencyResponse>	getLatencyAsync(String clusters, RequestOptions requestOptions)	(asynchronously) List the average latency for search requests for selected clusters.
InfrastructureResponse	getMetrics(Metric metric, Period period)	Report the aggregate value of a metric for a selected period of time.
InfrastructureResponse	getMetrics(Metric metric, Period period, RequestOptions requestOptions)	Report the aggregate value of a metric for a selected period of time.
CompletableFuture<InfrastructureResponse>	getMetricsAsync(Metric metric, Period period)	(asynchronously) Report the aggregate value of a metric for a selected period of time.
CompletableFuture<InfrastructureResponse>	getMetricsAsync(Metric metric, Period period, RequestOptions requestOptions)	(asynchronously) Report the aggregate value of a metric for a selected period of time.
Map<String,Map<String,Boolean>>	getReachability(String clusters)	Test whether clusters are reachable or not.
Map<String,Map<String,Boolean>>	getReachability(String clusters, RequestOptions requestOptions)	Test whether clusters are reachable or not.
CompletableFuture<Map<String,Map<String,Boolean>>>	getReachabilityAsync(String clusters)	(asynchronously) Test whether clusters are reachable or not.
CompletableFuture<Map<String,Map<String,Boolean>>>	getReachabilityAsync(String clusters, RequestOptions requestOptions)	(asynchronously) Test whether clusters are reachable or not.
StatusResponse	getStatus()	Report whether clusters are operational.
StatusResponse	getStatus(RequestOptions requestOptions)	Report whether clusters are operational.
CompletableFuture<StatusResponse>	getStatusAsync()	(asynchronously) Report whether clusters are operational.
CompletableFuture<StatusResponse>	getStatusAsync(RequestOptions requestOptions)	(asynchronously) Report whether clusters are operational.
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.
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

MonitoringClient

public MonitoringClient(String appId,
 String apiKey)

MonitoringClient

public MonitoringClient(String appId,
 String apiKey,
 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