Package com.algolia.api

Class MonitoringClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.MonitoringClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class MonitoringClient
extends ApiClient

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	customDelete(String path)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customGet(String path)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customPost(String path)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customPut(String path)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
IncidentsResponse	getClusterIncidents(String clusters)	Retrieves known incidents for the selected clusters.
IncidentsResponse	getClusterIncidents(String clusters, RequestOptions requestOptions)	Retrieves known incidents for the selected clusters.
CompletableFuture<IncidentsResponse>	getClusterIncidentsAsync(String clusters)	(asynchronously) Retrieves known incidents for the selected clusters.
CompletableFuture<IncidentsResponse>	getClusterIncidentsAsync(String clusters, RequestOptions requestOptions)	(asynchronously) Retrieves known incidents for the selected clusters.
StatusResponse	getClusterStatus(String clusters)	Retrieves the status of selected clusters.
StatusResponse	getClusterStatus(String clusters, RequestOptions requestOptions)	Retrieves the status of selected clusters.
CompletableFuture<StatusResponse>	getClusterStatusAsync(String clusters)	(asynchronously) Retrieves the status of selected clusters.
CompletableFuture<StatusResponse>	getClusterStatusAsync(String clusters, RequestOptions requestOptions)	(asynchronously) Retrieves the status of selected clusters.
IncidentsResponse	getIncidents()	Retrieves known incidents for all clusters.
IncidentsResponse	getIncidents(RequestOptions requestOptions)	Retrieves known incidents for all clusters.
CompletableFuture<IncidentsResponse>	getIncidentsAsync()	(asynchronously) Retrieves known incidents for all clusters.
CompletableFuture<IncidentsResponse>	getIncidentsAsync(RequestOptions requestOptions)	(asynchronously) Retrieves known incidents for all clusters.
IndexingTimeResponse	getIndexingTime(String clusters)	Retrieves average times for indexing operations for selected clusters.
IndexingTimeResponse	getIndexingTime(String clusters, RequestOptions requestOptions)	Retrieves average times for indexing operations for selected clusters.
CompletableFuture<IndexingTimeResponse>	getIndexingTimeAsync(String clusters)	(asynchronously) Retrieves average times for indexing operations for selected clusters.
CompletableFuture<IndexingTimeResponse>	getIndexingTimeAsync(String clusters, RequestOptions requestOptions)	(asynchronously) Retrieves average times for indexing operations for selected clusters.
LatencyResponse	getLatency(String clusters)	Retrieves the average latency for search requests for selected clusters.
LatencyResponse	getLatency(String clusters, RequestOptions requestOptions)	Retrieves the average latency for search requests for selected clusters.
CompletableFuture<LatencyResponse>	getLatencyAsync(String clusters)	(asynchronously) Retrieves the average latency for search requests for selected clusters.
CompletableFuture<LatencyResponse>	getLatencyAsync(String clusters, RequestOptions requestOptions)	(asynchronously) Retrieves the average latency for search requests for selected clusters.
InfrastructureResponse	getMetrics(Metric metric, Period period)	Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.
InfrastructureResponse	getMetrics(Metric metric, Period period, RequestOptions requestOptions)	Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.
CompletableFuture<InfrastructureResponse>	getMetricsAsync(Metric metric, Period period)	(asynchronously) Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.
CompletableFuture<InfrastructureResponse>	getMetricsAsync(Metric metric, Period period, RequestOptions requestOptions)	(asynchronously) Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.
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.
InventoryResponse	getServers()	Retrieves the servers that belong to clusters.
InventoryResponse	getServers(RequestOptions requestOptions)	Retrieves the servers that belong to clusters.
CompletableFuture<InventoryResponse>	getServersAsync()	(asynchronously) Retrieves the servers that belong to clusters.
CompletableFuture<InventoryResponse>	getServersAsync(RequestOptions requestOptions)	(asynchronously) Retrieves the servers that belong to clusters.
StatusResponse	getStatus()	Retrieves the status of all Algolia clusters and instances.
StatusResponse	getStatus(RequestOptions requestOptions)	Retrieves the status of all Algolia clusters and instances.
CompletableFuture<StatusResponse>	getStatusAsync()	(asynchronously) Retrieves the status of all Algolia clusters and instances.
CompletableFuture<StatusResponse>	getStatusAsync(RequestOptions requestOptions)	(asynchronously) Retrieves the status of all Algolia clusters and instances.

Methods inherited from class com.algolia.ApiClient

close, executeAsync, executeAsync

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

customDelete

public Object customDelete(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path,
 Map<String,Object> parameters)
                                            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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path,
 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)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

public CompletableFuture<Object> customDeleteAsync(@Nonnull
 String path)
                                            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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path,
 Map<String,Object> parameters)
                                         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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path,
 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)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

public CompletableFuture<Object> customGetAsync(@Nonnull
 String path)
                                         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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 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)

body - Parameters to send with the custom request. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                  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)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 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)

body - Parameters to send with the custom request. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                                          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)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path,
 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)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

public CompletableFuture<Object> customPostAsync(@Nonnull
 String path)
                                          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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 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)

body - Parameters to send with the custom request. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                 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)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 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.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 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)

body - Parameters to send with the custom request. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                                         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)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path,
 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)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

public CompletableFuture<Object> customPutAsync(@Nonnull
 String path)
                                         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)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClusterIncidents

public IncidentsResponse getClusterIncidents(@Nonnull
 String clusters,
 RequestOptions requestOptions)
                                      throws AlgoliaRuntimeException

Retrieves known incidents for the selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClusterIncidents

public IncidentsResponse getClusterIncidents(@Nonnull
 String clusters)
                                      throws AlgoliaRuntimeException

Retrieves known incidents for the selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClusterIncidentsAsync

public CompletableFuture<IncidentsResponse> getClusterIncidentsAsync(@Nonnull
 String clusters,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

(asynchronously) Retrieves known incidents for the selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClusterIncidentsAsync

public CompletableFuture<IncidentsResponse> getClusterIncidentsAsync(@Nonnull
 String clusters)
                                                              throws AlgoliaRuntimeException

(asynchronously) Retrieves known incidents for the selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClusterStatus

public StatusResponse getClusterStatus(@Nonnull
 String clusters,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Retrieves the status of selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClusterStatus

public StatusResponse getClusterStatus(@Nonnull
 String clusters)
                                throws AlgoliaRuntimeException

Retrieves the status of selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClusterStatusAsync

public CompletableFuture<StatusResponse> getClusterStatusAsync(@Nonnull
 String clusters,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves the status of selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getClusterStatusAsync

public CompletableFuture<StatusResponse> getClusterStatusAsync(@Nonnull
 String clusters)
                                                        throws AlgoliaRuntimeException

(asynchronously) Retrieves the status of selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getIncidents

public IncidentsResponse getIncidents(RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

Retrieves known incidents for all clusters.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getIncidents

public IncidentsResponse getIncidents()
                               throws AlgoliaRuntimeException

Retrieves known incidents for all clusters.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getIncidentsAsync

public CompletableFuture<IncidentsResponse> getIncidentsAsync(RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) Retrieves known incidents for all clusters.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getIncidentsAsync

public CompletableFuture<IncidentsResponse> getIncidentsAsync()
                                                       throws AlgoliaRuntimeException

(asynchronously) Retrieves known incidents for all clusters.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getIndexingTime

public IndexingTimeResponse getIndexingTime(@Nonnull
 String clusters,
 RequestOptions requestOptions)
                                     throws AlgoliaRuntimeException

Retrieves average times for indexing operations for selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getIndexingTime

public IndexingTimeResponse getIndexingTime(@Nonnull
 String clusters)
                                     throws AlgoliaRuntimeException

Retrieves average times for indexing operations for selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getIndexingTimeAsync

public CompletableFuture<IndexingTimeResponse> getIndexingTimeAsync(@Nonnull
 String clusters,
 RequestOptions requestOptions)
                                                             throws AlgoliaRuntimeException

(asynchronously) Retrieves average times for indexing operations for selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getIndexingTimeAsync

public CompletableFuture<IndexingTimeResponse> getIndexingTimeAsync(@Nonnull
 String clusters)
                                                             throws AlgoliaRuntimeException

(asynchronously) Retrieves average times for indexing operations for selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLatency

public LatencyResponse getLatency(@Nonnull
 String clusters,
 RequestOptions requestOptions)
                           throws AlgoliaRuntimeException

Retrieves the average latency for search requests for selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLatency

public LatencyResponse getLatency(@Nonnull
 String clusters)
                           throws AlgoliaRuntimeException

Retrieves the average latency for search requests for selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLatencyAsync

public CompletableFuture<LatencyResponse> getLatencyAsync(@Nonnull
 String clusters,
 RequestOptions requestOptions)
                                                   throws AlgoliaRuntimeException

(asynchronously) Retrieves the average latency for search requests for selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLatencyAsync

public CompletableFuture<LatencyResponse> getLatencyAsync(@Nonnull
 String clusters)
                                                   throws AlgoliaRuntimeException

(asynchronously) Retrieves the average latency for search requests for selected clusters.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getMetrics

public InfrastructureResponse getMetrics(@Nonnull
 Metric metric,
 @Nonnull
 Period period,
 RequestOptions requestOptions)
                                  throws AlgoliaRuntimeException

Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).

Parameters:

metric - Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required)

period - Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getMetrics

public InfrastructureResponse getMetrics(@Nonnull
 Metric metric,
 @Nonnull
 Period period)
                                  throws AlgoliaRuntimeException

Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).

Parameters:

metric - Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required)

period - Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getMetricsAsync

public CompletableFuture<InfrastructureResponse> getMetricsAsync(@Nonnull
 Metric metric,
 @Nonnull
 Period period,
 RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

(asynchronously) Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).

Parameters:

metric - Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required)

period - Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getMetricsAsync

public CompletableFuture<InfrastructureResponse> getMetricsAsync(@Nonnull
 Metric metric,
 @Nonnull
 Period period)
                                                          throws AlgoliaRuntimeException

(asynchronously) Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).

Parameters:

metric - Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required)

period - Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getReachability

public Map<String,Map<String,Boolean>> getReachability(@Nonnull
 String clusters,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

Test whether clusters are reachable or not.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getReachability

public Map<String,Map<String,Boolean>> getReachability(@Nonnull
 String clusters)
                                                throws AlgoliaRuntimeException

Test whether clusters are reachable or not.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getReachabilityAsync

public CompletableFuture<Map<String,Map<String,Boolean>>> getReachabilityAsync(@Nonnull
 String clusters,
 RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Test whether clusters are reachable or not.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getReachabilityAsync

public CompletableFuture<Map<String,Map<String,Boolean>>> getReachabilityAsync(@Nonnull
 String clusters)
                                                                        throws AlgoliaRuntimeException

(asynchronously) Test whether clusters are reachable or not.

Parameters:

clusters - Subset of clusters, separated by comma. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getServers

public InventoryResponse getServers(RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getServers

public InventoryResponse getServers()
                             throws AlgoliaRuntimeException

Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getServersAsync

public CompletableFuture<InventoryResponse> getServersAsync(RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getServersAsync

public CompletableFuture<InventoryResponse> getServersAsync()
                                                     throws AlgoliaRuntimeException

(asynchronously) Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getStatus

public StatusResponse getStatus(RequestOptions requestOptions)
                         throws AlgoliaRuntimeException

Retrieves the status of all Algolia clusters and instances.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getStatus

public StatusResponse getStatus()
                         throws AlgoliaRuntimeException

Retrieves the status of all Algolia clusters and instances.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getStatusAsync

public CompletableFuture<StatusResponse> getStatusAsync(RequestOptions requestOptions)
                                                 throws AlgoliaRuntimeException

(asynchronously) Retrieves the status of all Algolia clusters and instances.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getStatusAsync

public CompletableFuture<StatusResponse> getStatusAsync()
                                                 throws AlgoliaRuntimeException

(asynchronously) Retrieves the status of all Algolia clusters and instances.

Throws:

AlgoliaRuntimeException - If it fails to process the API call