Package co.elastic.clients.elasticsearch.cluster

Class ElasticsearchClusterAsyncClient

java.lang.Object

co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchClusterAsyncClient>

co.elastic.clients.elasticsearch.cluster.ElasticsearchClusterAsyncClient

public class ElasticsearchClusterAsyncClient
extends ApiClient<ElasticsearchTransport,ElasticsearchClusterAsyncClient>

Client for the cluster namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
ElasticsearchClusterAsyncClient(ElasticsearchTransport transport)
ElasticsearchClusterAsyncClient(ElasticsearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<AllocationExplainResponse>	allocationExplain()	Provides explanations for shard allocations in the cluster.
java.util.concurrent.CompletableFuture<AllocationExplainResponse>	allocationExplain(AllocationExplainRequest request)	Provides explanations for shard allocations in the cluster.
java.util.concurrent.CompletableFuture<AllocationExplainResponse>	allocationExplain(java.util.function.Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn)	Provides explanations for shard allocations in the cluster.
java.util.concurrent.CompletableFuture<DeleteComponentTemplateResponse>	deleteComponentTemplate(DeleteComponentTemplateRequest request)	Deletes a component template
java.util.concurrent.CompletableFuture<DeleteComponentTemplateResponse>	deleteComponentTemplate(java.util.function.Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn)	Deletes a component template
java.util.concurrent.CompletableFuture<BooleanResponse>	deleteVotingConfigExclusions()	Clears cluster voting config exclusions.
java.util.concurrent.CompletableFuture<BooleanResponse>	deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)	Clears cluster voting config exclusions.
java.util.concurrent.CompletableFuture<BooleanResponse>	deleteVotingConfigExclusions(java.util.function.Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn)	Clears cluster voting config exclusions.
java.util.concurrent.CompletableFuture<BooleanResponse>	existsComponentTemplate(ExistsComponentTemplateRequest request)	Returns information about whether a particular component template exist
java.util.concurrent.CompletableFuture<BooleanResponse>	existsComponentTemplate(java.util.function.Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn)	Returns information about whether a particular component template exist
java.util.concurrent.CompletableFuture<GetComponentTemplateResponse>	getComponentTemplate()	Returns one or more component templates
java.util.concurrent.CompletableFuture<GetComponentTemplateResponse>	getComponentTemplate(GetComponentTemplateRequest request)	Returns one or more component templates
java.util.concurrent.CompletableFuture<GetComponentTemplateResponse>	getComponentTemplate(java.util.function.Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)	Returns one or more component templates
java.util.concurrent.CompletableFuture<GetClusterSettingsResponse>	getSettings()	Returns cluster settings.
java.util.concurrent.CompletableFuture<GetClusterSettingsResponse>	getSettings(GetClusterSettingsRequest request)	Returns cluster settings.
java.util.concurrent.CompletableFuture<GetClusterSettingsResponse>	getSettings(java.util.function.Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)	Returns cluster settings.
java.util.concurrent.CompletableFuture<HealthResponse>	health()	Returns basic information about the health of the cluster.
java.util.concurrent.CompletableFuture<HealthResponse>	health(HealthRequest request)	Returns basic information about the health of the cluster.
java.util.concurrent.CompletableFuture<HealthResponse>	health(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)	Returns basic information about the health of the cluster.
java.util.concurrent.CompletableFuture<PendingTasksResponse>	pendingTasks()	Returns a list of any cluster-level changes (e.g.
java.util.concurrent.CompletableFuture<PendingTasksResponse>	pendingTasks(PendingTasksRequest request)	Returns a list of any cluster-level changes (e.g.
java.util.concurrent.CompletableFuture<PendingTasksResponse>	pendingTasks(java.util.function.Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)	Returns a list of any cluster-level changes (e.g.
java.util.concurrent.CompletableFuture<BooleanResponse>	postVotingConfigExclusions()	Updates the cluster voting config exclusions by node ids or node names.
java.util.concurrent.CompletableFuture<BooleanResponse>	postVotingConfigExclusions(PostVotingConfigExclusionsRequest request)	Updates the cluster voting config exclusions by node ids or node names.
java.util.concurrent.CompletableFuture<BooleanResponse>	postVotingConfigExclusions(java.util.function.Function<PostVotingConfigExclusionsRequest.Builder,ObjectBuilder<PostVotingConfigExclusionsRequest>> fn)	Updates the cluster voting config exclusions by node ids or node names.
java.util.concurrent.CompletableFuture<PutComponentTemplateResponse>	putComponentTemplate(PutComponentTemplateRequest request)	Creates or updates a component template
java.util.concurrent.CompletableFuture<PutComponentTemplateResponse>	putComponentTemplate(java.util.function.Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)	Creates or updates a component template
java.util.concurrent.CompletableFuture<PutClusterSettingsResponse>	putSettings()	Updates the cluster settings.
java.util.concurrent.CompletableFuture<PutClusterSettingsResponse>	putSettings(PutClusterSettingsRequest request)	Updates the cluster settings.
java.util.concurrent.CompletableFuture<PutClusterSettingsResponse>	putSettings(java.util.function.Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)	Updates the cluster settings.
java.util.concurrent.CompletableFuture<RemoteInfoResponse>	remoteInfo()	Returns the information about configured remote clusters.
java.util.concurrent.CompletableFuture<RerouteResponse>	reroute()	Allows to manually change the allocation of individual shards in the cluster.
java.util.concurrent.CompletableFuture<RerouteResponse>	reroute(RerouteRequest request)	Allows to manually change the allocation of individual shards in the cluster.
java.util.concurrent.CompletableFuture<RerouteResponse>	reroute(java.util.function.Function<RerouteRequest.Builder,ObjectBuilder<RerouteRequest>> fn)	Allows to manually change the allocation of individual shards in the cluster.
java.util.concurrent.CompletableFuture<StateResponse>	state()	Returns a comprehensive information about the state of the cluster.
java.util.concurrent.CompletableFuture<StateResponse>	state(StateRequest request)	Returns a comprehensive information about the state of the cluster.
java.util.concurrent.CompletableFuture<StateResponse>	state(java.util.function.Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn)	Returns a comprehensive information about the state of the cluster.
java.util.concurrent.CompletableFuture<ClusterStatsResponse>	stats()	Returns high-level overview of cluster statistics.
java.util.concurrent.CompletableFuture<ClusterStatsResponse>	stats(ClusterStatsRequest request)	Returns high-level overview of cluster statistics.
java.util.concurrent.CompletableFuture<ClusterStatsResponse>	stats(java.util.function.Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)	Returns high-level overview of cluster statistics.
ElasticsearchClusterAsyncClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class co.elastic.clients.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchClusterAsyncClient

public ElasticsearchClusterAsyncClient(ElasticsearchTransport transport)

ElasticsearchClusterAsyncClient

public ElasticsearchClusterAsyncClient(ElasticsearchTransport transport,
@Nullable
TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchClusterAsyncClient withTransportOptions(@Nullable
TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchClusterAsyncClient>

allocationExplain

public java.util.concurrent.CompletableFuture<AllocationExplainResponse> allocationExplain(AllocationExplainRequest request)
                                                                                    throws java.io.IOException,
ElasticsearchException

Provides explanations for shard allocations in the cluster.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

allocationExplain

public final java.util.concurrent.CompletableFuture<AllocationExplainResponse> allocationExplain(java.util.function.Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn)
                                                                                          throws java.io.IOException,
ElasticsearchException

Provides explanations for shard allocations in the cluster.

Parameters:

fn - a function that initializes a builder to create the AllocationExplainRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

allocationExplain

public java.util.concurrent.CompletableFuture<AllocationExplainResponse> allocationExplain()
                                                                                    throws java.io.IOException,
ElasticsearchException

Provides explanations for shard allocations in the cluster.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

deleteComponentTemplate

public java.util.concurrent.CompletableFuture<DeleteComponentTemplateResponse> deleteComponentTemplate(DeleteComponentTemplateRequest request)
                                                                                                throws java.io.IOException,
ElasticsearchException

Deletes a component template

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

deleteComponentTemplate

public final java.util.concurrent.CompletableFuture<DeleteComponentTemplateResponse> deleteComponentTemplate(java.util.function.Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn)
                                                                                                      throws java.io.IOException,
ElasticsearchException

Deletes a component template

Parameters:

fn - a function that initializes a builder to create the DeleteComponentTemplateRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

deleteVotingConfigExclusions

public java.util.concurrent.CompletableFuture<BooleanResponse> deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)
                                                                                     throws java.io.IOException,
ElasticsearchException

Clears cluster voting config exclusions.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

deleteVotingConfigExclusions

public final java.util.concurrent.CompletableFuture<BooleanResponse> deleteVotingConfigExclusions(java.util.function.Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn)
                                                                                           throws java.io.IOException,
ElasticsearchException

Clears cluster voting config exclusions.

Parameters:

fn - a function that initializes a builder to create the DeleteVotingConfigExclusionsRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

deleteVotingConfigExclusions

public java.util.concurrent.CompletableFuture<BooleanResponse> deleteVotingConfigExclusions()
                                                                                     throws java.io.IOException,
ElasticsearchException

Clears cluster voting config exclusions.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

existsComponentTemplate

public java.util.concurrent.CompletableFuture<BooleanResponse> existsComponentTemplate(ExistsComponentTemplateRequest request)
                                                                                throws java.io.IOException,
ElasticsearchException

Returns information about whether a particular component template exist

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

existsComponentTemplate

public final java.util.concurrent.CompletableFuture<BooleanResponse> existsComponentTemplate(java.util.function.Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn)
                                                                                      throws java.io.IOException,
ElasticsearchException

Returns information about whether a particular component template exist

Parameters:

fn - a function that initializes a builder to create the ExistsComponentTemplateRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getComponentTemplate

public java.util.concurrent.CompletableFuture<GetComponentTemplateResponse> getComponentTemplate(GetComponentTemplateRequest request)
                                                                                          throws java.io.IOException,
ElasticsearchException

Returns one or more component templates

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getComponentTemplate

public final java.util.concurrent.CompletableFuture<GetComponentTemplateResponse> getComponentTemplate(java.util.function.Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)
                                                                                                throws java.io.IOException,
ElasticsearchException

Returns one or more component templates

Parameters:

fn - a function that initializes a builder to create the GetComponentTemplateRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getComponentTemplate

public java.util.concurrent.CompletableFuture<GetComponentTemplateResponse> getComponentTemplate()
                                                                                          throws java.io.IOException,
ElasticsearchException

Returns one or more component templates

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getSettings

public java.util.concurrent.CompletableFuture<GetClusterSettingsResponse> getSettings(GetClusterSettingsRequest request)
                                                                               throws java.io.IOException,
ElasticsearchException

Returns cluster settings.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getSettings

public final java.util.concurrent.CompletableFuture<GetClusterSettingsResponse> getSettings(java.util.function.Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)
                                                                                     throws java.io.IOException,
ElasticsearchException

Returns cluster settings.

Parameters:

fn - a function that initializes a builder to create the GetClusterSettingsRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

getSettings

public java.util.concurrent.CompletableFuture<GetClusterSettingsResponse> getSettings()
                                                                               throws java.io.IOException,
ElasticsearchException

Returns cluster settings.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

health

public java.util.concurrent.CompletableFuture<HealthResponse> health(HealthRequest request)
                                                              throws java.io.IOException,
ElasticsearchException

Returns basic information about the health of the cluster.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

health

public final java.util.concurrent.CompletableFuture<HealthResponse> health(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)
                                                                    throws java.io.IOException,
ElasticsearchException

Returns basic information about the health of the cluster.

Parameters:

fn - a function that initializes a builder to create the HealthRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

health

public java.util.concurrent.CompletableFuture<HealthResponse> health()
                                                              throws java.io.IOException,
ElasticsearchException

Returns basic information about the health of the cluster.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

pendingTasks

public java.util.concurrent.CompletableFuture<PendingTasksResponse> pendingTasks(PendingTasksRequest request)
                                                                          throws java.io.IOException,
ElasticsearchException

Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

pendingTasks

public final java.util.concurrent.CompletableFuture<PendingTasksResponse> pendingTasks(java.util.function.Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)
                                                                                throws java.io.IOException,
ElasticsearchException

Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed.

Parameters:

fn - a function that initializes a builder to create the PendingTasksRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

pendingTasks

public java.util.concurrent.CompletableFuture<PendingTasksResponse> pendingTasks()
                                                                          throws java.io.IOException,
ElasticsearchException

Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

postVotingConfigExclusions

public java.util.concurrent.CompletableFuture<BooleanResponse> postVotingConfigExclusions(PostVotingConfigExclusionsRequest request)
                                                                                   throws java.io.IOException,
ElasticsearchException

Updates the cluster voting config exclusions by node ids or node names.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

postVotingConfigExclusions

public final java.util.concurrent.CompletableFuture<BooleanResponse> postVotingConfigExclusions(java.util.function.Function<PostVotingConfigExclusionsRequest.Builder,ObjectBuilder<PostVotingConfigExclusionsRequest>> fn)
                                                                                         throws java.io.IOException,
ElasticsearchException

Updates the cluster voting config exclusions by node ids or node names.

Parameters:

fn - a function that initializes a builder to create the PostVotingConfigExclusionsRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

postVotingConfigExclusions

public java.util.concurrent.CompletableFuture<BooleanResponse> postVotingConfigExclusions()
                                                                                   throws java.io.IOException,
ElasticsearchException

Updates the cluster voting config exclusions by node ids or node names.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

putComponentTemplate

public java.util.concurrent.CompletableFuture<PutComponentTemplateResponse> putComponentTemplate(PutComponentTemplateRequest request)
                                                                                          throws java.io.IOException,
ElasticsearchException

Creates or updates a component template

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

putComponentTemplate

public final java.util.concurrent.CompletableFuture<PutComponentTemplateResponse> putComponentTemplate(java.util.function.Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)
                                                                                                throws java.io.IOException,
ElasticsearchException

Creates or updates a component template

Parameters:

fn - a function that initializes a builder to create the PutComponentTemplateRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

putSettings

public java.util.concurrent.CompletableFuture<PutClusterSettingsResponse> putSettings(PutClusterSettingsRequest request)
                                                                               throws java.io.IOException,
ElasticsearchException

Updates the cluster settings.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

putSettings

public final java.util.concurrent.CompletableFuture<PutClusterSettingsResponse> putSettings(java.util.function.Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)
                                                                                     throws java.io.IOException,
ElasticsearchException

Updates the cluster settings.

Parameters:

fn - a function that initializes a builder to create the PutClusterSettingsRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

putSettings

public java.util.concurrent.CompletableFuture<PutClusterSettingsResponse> putSettings()
                                                                               throws java.io.IOException,
ElasticsearchException

Updates the cluster settings.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

remoteInfo

public java.util.concurrent.CompletableFuture<RemoteInfoResponse> remoteInfo()
                                                                      throws java.io.IOException,
ElasticsearchException

Returns the information about configured remote clusters.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

reroute

public java.util.concurrent.CompletableFuture<RerouteResponse> reroute(RerouteRequest request)
                                                                throws java.io.IOException,
ElasticsearchException

Allows to manually change the allocation of individual shards in the cluster.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

reroute

public final java.util.concurrent.CompletableFuture<RerouteResponse> reroute(java.util.function.Function<RerouteRequest.Builder,ObjectBuilder<RerouteRequest>> fn)
                                                                      throws java.io.IOException,
ElasticsearchException

Allows to manually change the allocation of individual shards in the cluster.

Parameters:

fn - a function that initializes a builder to create the RerouteRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

reroute

public java.util.concurrent.CompletableFuture<RerouteResponse> reroute()
                                                                throws java.io.IOException,
ElasticsearchException

Allows to manually change the allocation of individual shards in the cluster.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

state

public java.util.concurrent.CompletableFuture<StateResponse> state(StateRequest request)
                                                            throws java.io.IOException,
ElasticsearchException

Returns a comprehensive information about the state of the cluster.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

state

public final java.util.concurrent.CompletableFuture<StateResponse> state(java.util.function.Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn)
                                                                  throws java.io.IOException,
ElasticsearchException

Returns a comprehensive information about the state of the cluster.

Parameters:

fn - a function that initializes a builder to create the StateRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

state

public java.util.concurrent.CompletableFuture<StateResponse> state()
                                                            throws java.io.IOException,
ElasticsearchException

Returns a comprehensive information about the state of the cluster.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

stats

public java.util.concurrent.CompletableFuture<ClusterStatsResponse> stats(ClusterStatsRequest request)
                                                                   throws java.io.IOException,
ElasticsearchException

Returns high-level overview of cluster statistics.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

stats

public final java.util.concurrent.CompletableFuture<ClusterStatsResponse> stats(java.util.function.Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)
                                                                         throws java.io.IOException,
ElasticsearchException

Returns high-level overview of cluster statistics.

Parameters:

fn - a function that initializes a builder to create the ClusterStatsRequest

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co

stats

public java.util.concurrent.CompletableFuture<ClusterStatsResponse> stats()
                                                                   throws java.io.IOException,
ElasticsearchException

Returns high-level overview of cluster statistics.

Throws:

java.io.IOException

ElasticsearchException

See Also:

Documentation on elastic.co