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
ClusterGetSettingsResponse	getSettings(ClusterGetSettingsRequest clusterGetSettingsRequest, RequestOptions options)	Get the cluster wide settings using the Cluster Get Settings API.
void	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.
void	healthAsync(ClusterHealthRequest healthRequest, RequestOptions options, ActionListener<ClusterHealthResponse> listener)	Asynchronously get cluster health using the Cluster Health API.
ClusterUpdateSettingsResponse	putSettings(ClusterUpdateSettingsRequest clusterUpdateSettingsRequest, org.apache.http.Header... headers)	Deprecated. Prefer putSettings(ClusterUpdateSettingsRequest, RequestOptions)
ClusterUpdateSettingsResponse	putSettings(ClusterUpdateSettingsRequest clusterUpdateSettingsRequest, RequestOptions options)	Updates cluster wide specific settings using the Cluster Update Settings API.
void	putSettingsAsync(ClusterUpdateSettingsRequest clusterUpdateSettingsRequest, ActionListener<ClusterUpdateSettingsResponse> listener, org.apache.http.Header... headers)	Deprecated. Prefer putSettingsAsync(ClusterUpdateSettingsRequest, RequestOptions, ActionListener)
void	putSettingsAsync(ClusterUpdateSettingsRequest clusterUpdateSettingsRequest, RequestOptions options, ActionListener<ClusterUpdateSettingsResponse> listener)	Asynchronously updates cluster wide specific settings using the Cluster Update Settings API.

Methods inherited from class java.lang.Object

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

Method Detail

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

putSettings

@Deprecated
public ClusterUpdateSettingsResponse putSettings(ClusterUpdateSettingsRequest clusterUpdateSettingsRequest,
                                                 org.apache.http.Header... headers)
                                          throws java.io.IOException

Deprecated.

Prefer putSettings(ClusterUpdateSettingsRequest, RequestOptions)

Updates cluster wide specific settings using the Cluster Update Settings API.

See Cluster Update Settings API on elastic.co

Throws:

java.io.IOException

putSettingsAsync

public void 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

putSettingsAsync

@Deprecated
public void putSettingsAsync(ClusterUpdateSettingsRequest clusterUpdateSettingsRequest,
                             ActionListener<ClusterUpdateSettingsResponse> listener,
                             org.apache.http.Header... headers)

Deprecated.

Prefer putSettingsAsync(ClusterUpdateSettingsRequest, RequestOptions, ActionListener)

Asynchronously updates cluster wide specific settings using the Cluster Update Settings API.

See Cluster Update Settings API on elastic.co

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 void 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

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 void 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