Package org.elasticsearch.client

Class ClusterClient

java.lang.Object

org.elasticsearch.client.ClusterClient

public final class ClusterClient
extends java.lang.Object

A wrapper for the RestHighLevelClient that provides methods for accessing the Cluster API.

See Cluster API on elastic.co

Method Summary

Modifier and Type	Method	Description
AcknowledgedResponse	deleteComponentTemplate(DeleteComponentTemplateRequest req, RequestOptions options)	Delete a component template using the Component Templates API
Cancellable	deleteComponentTemplateAsync(DeleteComponentTemplateRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously delete a component template using the Component Templates API
boolean	existsComponentTemplate(ComponentTemplatesExistRequest componentTemplatesRequest, RequestOptions options)	Uses the Component Templates API to determine if component templates exist
Cancellable	existsComponentTemplateAsync(ComponentTemplatesExistRequest componentTemplatesRequest, RequestOptions options, ActionListener<java.lang.Boolean> listener)	Uses the Index Templates API to determine if index templates exist
GetComponentTemplatesResponse	getComponentTemplate(GetComponentTemplatesRequest getComponentTemplatesRequest, RequestOptions options)	Gets component templates using the Components Templates API
Cancellable	getComponentTemplateAsync(GetComponentTemplatesRequest getComponentTemplatesRequest, RequestOptions options, ActionListener<GetComponentTemplatesResponse> listener)	Asynchronously gets component templates using the Components Templates API
ClusterGetSettingsResponse	getSettings(ClusterGetSettingsRequest clusterGetSettingsRequest, RequestOptions options)	Get the cluster wide settings using the Cluster Get Settings API.
Cancellable	getSettingsAsync(ClusterGetSettingsRequest clusterGetSettingsRequest, RequestOptions options, ActionListener<ClusterGetSettingsResponse> listener)	Asynchronously get the cluster wide settings using the Cluster Get Settings API.
ClusterHealthResponse	health(ClusterHealthRequest healthRequest, RequestOptions options)	Get cluster health using the Cluster Health API.
Cancellable	healthAsync(ClusterHealthRequest healthRequest, RequestOptions options, ActionListener<ClusterHealthResponse> listener)	Asynchronously get cluster health using the Cluster Health API.
AcknowledgedResponse	putComponentTemplate(PutComponentTemplateRequest putComponentTemplateRequest, RequestOptions options)	Puts a component template using the Component Templates API.
Cancellable	putComponentTemplateAsync(PutComponentTemplateRequest putComponentTemplateRequest, RequestOptions options, ActionListener<AcknowledgedResponse> listener)	Asynchronously puts a component template using the Component Templates API.
ClusterUpdateSettingsResponse	putSettings(ClusterUpdateSettingsRequest clusterUpdateSettingsRequest, RequestOptions options)	Updates cluster wide specific settings using the Cluster Update Settings API.
Cancellable	putSettingsAsync(ClusterUpdateSettingsRequest clusterUpdateSettingsRequest, RequestOptions options, ActionListener<ClusterUpdateSettingsResponse> listener)	Asynchronously updates cluster wide specific settings using the Cluster Update Settings API.
RemoteInfoResponse	remoteInfo(RemoteInfoRequest request, RequestOptions options)	Get the remote cluster information using the Remote cluster info API.
Cancellable	remoteInfoAsync(RemoteInfoRequest request, RequestOptions options, ActionListener<RemoteInfoResponse> listener)	Asynchronously get remote cluster information using the Remote cluster info API.

Methods inherited from class java.lang.Object

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

Method Details

putSettings

public ClusterUpdateSettingsResponse putSettings(ClusterUpdateSettingsRequest clusterUpdateSettingsRequest, RequestOptions options) throws java.io.IOException

Updates cluster wide specific settings using the Cluster Update Settings API. See Cluster Update Settings API on elastic.co

Parameters:

clusterUpdateSettingsRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

putSettingsAsync

public Cancellable putSettingsAsync(ClusterUpdateSettingsRequest clusterUpdateSettingsRequest, RequestOptions options, ActionListener<ClusterUpdateSettingsResponse> listener)

Asynchronously updates cluster wide specific settings using the Cluster Update Settings API. See Cluster Update Settings API on elastic.co

Parameters:

clusterUpdateSettingsRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getSettings

public ClusterGetSettingsResponse getSettings(ClusterGetSettingsRequest clusterGetSettingsRequest, RequestOptions options) throws java.io.IOException

Get the cluster wide settings using the Cluster Get Settings API. See Cluster Get Settings API on elastic.co

Parameters:

clusterGetSettingsRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

getSettingsAsync

public Cancellable getSettingsAsync(ClusterGetSettingsRequest clusterGetSettingsRequest, RequestOptions options, ActionListener<ClusterGetSettingsResponse> listener)

Asynchronously get the cluster wide settings using the Cluster Get Settings API. See Cluster Get Settings API on elastic.co

Parameters:

clusterGetSettingsRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

health

public ClusterHealthResponse health(ClusterHealthRequest healthRequest, RequestOptions options) throws java.io.IOException

Get cluster health using the Cluster Health API. See Cluster Health API on elastic.co

If timeout occurred, ClusterHealthResponse will have isTimedOut() == true and status() == RestStatus.REQUEST_TIMEOUT

Parameters:

healthRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

healthAsync

public Cancellable healthAsync(ClusterHealthRequest healthRequest, RequestOptions options, ActionListener<ClusterHealthResponse> listener)

Asynchronously get cluster health using the Cluster Health API. See Cluster Health API on elastic.co If timeout occurred, ClusterHealthResponse will have isTimedOut() == true and status() == RestStatus.REQUEST_TIMEOUT

Parameters:

healthRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

remoteInfo

public RemoteInfoResponse remoteInfo(RemoteInfoRequest request, RequestOptions options) throws java.io.IOException

Get the remote cluster information using the Remote cluster info API. See Remote cluster info API on elastic.co

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

remoteInfoAsync

public Cancellable remoteInfoAsync(RemoteInfoRequest request, RequestOptions options, ActionListener<RemoteInfoResponse> listener)

Asynchronously get remote cluster information using the Remote cluster info API. See Remote cluster info API on elastic.co

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

deleteComponentTemplate

public AcknowledgedResponse deleteComponentTemplate(DeleteComponentTemplateRequest req, RequestOptions options) throws java.io.IOException

Delete a component template using the Component Templates API

Parameters:

req - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

deleteComponentTemplateAsync

public Cancellable deleteComponentTemplateAsync(DeleteComponentTemplateRequest request, RequestOptions options, ActionListener<AcknowledgedResponse> listener)

Asynchronously delete a component template using the Component Templates API

Parameters:

request - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

putComponentTemplate

public AcknowledgedResponse putComponentTemplate(PutComponentTemplateRequest putComponentTemplateRequest, RequestOptions options) throws java.io.IOException

Puts a component template using the Component Templates API.

Parameters:

putComponentTemplateRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

putComponentTemplateAsync

public Cancellable putComponentTemplateAsync(PutComponentTemplateRequest putComponentTemplateRequest, RequestOptions options, ActionListener<AcknowledgedResponse> listener)

Asynchronously puts a component template using the Component Templates API.

Parameters:

putComponentTemplateRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

getComponentTemplate

public GetComponentTemplatesResponse getComponentTemplate(GetComponentTemplatesRequest getComponentTemplatesRequest, RequestOptions options) throws java.io.IOException

Gets component templates using the Components Templates API

Parameters:

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

getComponentTemplatesRequest - the request

Returns:

the response

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

getComponentTemplateAsync

public Cancellable getComponentTemplateAsync(GetComponentTemplatesRequest getComponentTemplatesRequest, RequestOptions options, ActionListener<GetComponentTemplatesResponse> listener)

Asynchronously gets component templates using the Components Templates API

Parameters:

getComponentTemplatesRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion

Returns:

cancellable that may be used to cancel the request

existsComponentTemplate

public boolean existsComponentTemplate(ComponentTemplatesExistRequest componentTemplatesRequest, RequestOptions options) throws java.io.IOException

Uses the Component Templates API to determine if component templates exist

Parameters:

componentTemplatesRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

Returns:

true if any index templates in the request exist, false otherwise

Throws:

java.io.IOException - in case there is a problem sending the request or parsing back the response

existsComponentTemplateAsync

public Cancellable existsComponentTemplateAsync(ComponentTemplatesExistRequest componentTemplatesRequest, RequestOptions options, ActionListener<java.lang.Boolean> listener)

Uses the Index Templates API to determine if index templates exist

Parameters:

componentTemplatesRequest - the request

options - the request options (e.g. headers), use RequestOptions.DEFAULT if nothing needs to be customized

listener - the listener to be notified upon request completion. The listener will be called with the value true

Returns:

cancellable that may be used to cancel the request