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

_jsonpMapper, _transport, _transportOptions, getDeserializer, withTransportOptions

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 CompletableFuture<AllocationExplainResponse> allocationExplain(AllocationExplainRequest request)

Provides explanations for shard allocations in the cluster.

See Also:

• Documentation on elastic.co

allocationExplain

public final CompletableFuture<AllocationExplainResponse> allocationExplain(Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn)

Provides explanations for shard allocations in the cluster.

Parameters:

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

See Also:

• Documentation on elastic.co

allocationExplain

public CompletableFuture<AllocationExplainResponse> allocationExplain()

Provides explanations for shard allocations in the cluster.

See Also:

• Documentation on elastic.co

deleteComponentTemplate

public CompletableFuture<DeleteComponentTemplateResponse> deleteComponentTemplate(DeleteComponentTemplateRequest request)

Deletes a component template

See Also:

• Documentation on elastic.co

deleteComponentTemplate

public final CompletableFuture<DeleteComponentTemplateResponse> deleteComponentTemplate(Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn)

Deletes a component template

Parameters:

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

See Also:

• Documentation on elastic.co

deleteVotingConfigExclusions

public CompletableFuture<BooleanResponse> deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)

Clears cluster voting config exclusions.

See Also:

• Documentation on elastic.co

deleteVotingConfigExclusions

public final CompletableFuture<BooleanResponse> deleteVotingConfigExclusions(Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn)

Clears cluster voting config exclusions.

Parameters:

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

See Also:

• Documentation on elastic.co

deleteVotingConfigExclusions

public CompletableFuture<BooleanResponse> deleteVotingConfigExclusions()

Clears cluster voting config exclusions.

See Also:

• Documentation on elastic.co

existsComponentTemplate

public CompletableFuture<BooleanResponse> existsComponentTemplate(ExistsComponentTemplateRequest request)

Returns information about whether a particular component template exist

See Also:

• Documentation on elastic.co

existsComponentTemplate

public final CompletableFuture<BooleanResponse> existsComponentTemplate(Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn)

Returns information about whether a particular component template exist

Parameters:

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

See Also:

• Documentation on elastic.co

getComponentTemplate

public CompletableFuture<GetComponentTemplateResponse> getComponentTemplate(GetComponentTemplateRequest request)

Returns one or more component templates

See Also:

• Documentation on elastic.co

getComponentTemplate

public final CompletableFuture<GetComponentTemplateResponse> getComponentTemplate(Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)

Returns one or more component templates

Parameters:

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

See Also:

• Documentation on elastic.co

getComponentTemplate

public CompletableFuture<GetComponentTemplateResponse> getComponentTemplate()

Returns one or more component templates

See Also:

• Documentation on elastic.co

getSettings

public CompletableFuture<GetClusterSettingsResponse> getSettings(GetClusterSettingsRequest request)

Returns cluster settings.

See Also:

• Documentation on elastic.co

getSettings

public final CompletableFuture<GetClusterSettingsResponse> getSettings(Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)

Returns cluster settings.

Parameters:

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

See Also:

• Documentation on elastic.co

getSettings

public CompletableFuture<GetClusterSettingsResponse> getSettings()

Returns cluster settings.

See Also:

• Documentation on elastic.co

health

public CompletableFuture<HealthResponse> health(HealthRequest request)

Returns basic information about the health of the cluster.

See Also:

• Documentation on elastic.co

health

public final CompletableFuture<HealthResponse> health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)

Returns basic information about the health of the cluster.

Parameters:

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

See Also:

• Documentation on elastic.co

health

public CompletableFuture<HealthResponse> health()

Returns basic information about the health of the cluster.

See Also:

• Documentation on elastic.co

pendingTasks

public CompletableFuture<PendingTasksResponse> pendingTasks(PendingTasksRequest request)

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

See Also:

• Documentation on elastic.co

pendingTasks

public final CompletableFuture<PendingTasksResponse> pendingTasks(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)

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

See Also:

• Documentation on elastic.co

pendingTasks

public CompletableFuture<PendingTasksResponse> pendingTasks()

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

See Also:

• Documentation on elastic.co

postVotingConfigExclusions

public CompletableFuture<BooleanResponse> postVotingConfigExclusions(PostVotingConfigExclusionsRequest request)

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

See Also:

• Documentation on elastic.co

postVotingConfigExclusions

public final CompletableFuture<BooleanResponse> postVotingConfigExclusions(Function<PostVotingConfigExclusionsRequest.Builder,ObjectBuilder<PostVotingConfigExclusionsRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

postVotingConfigExclusions

public CompletableFuture<BooleanResponse> postVotingConfigExclusions()

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

See Also:

• Documentation on elastic.co

putComponentTemplate

public CompletableFuture<PutComponentTemplateResponse> putComponentTemplate(PutComponentTemplateRequest request)

Creates or updates a component template

See Also:

• Documentation on elastic.co

putComponentTemplate

public final CompletableFuture<PutComponentTemplateResponse> putComponentTemplate(Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)

Creates or updates a component template

Parameters:

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

See Also:

• Documentation on elastic.co

putSettings

public CompletableFuture<PutClusterSettingsResponse> putSettings(PutClusterSettingsRequest request)

Updates the cluster settings.

See Also:

• Documentation on elastic.co

putSettings

public final CompletableFuture<PutClusterSettingsResponse> putSettings(Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)

Updates the cluster settings.

Parameters:

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

See Also:

• Documentation on elastic.co

putSettings

public CompletableFuture<PutClusterSettingsResponse> putSettings()

Updates the cluster settings.

See Also:

• Documentation on elastic.co

remoteInfo

public CompletableFuture<RemoteInfoResponse> remoteInfo()

Returns the information about configured remote clusters.

See Also:

• Documentation on elastic.co

reroute

public CompletableFuture<RerouteResponse> reroute(RerouteRequest request)

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

See Also:

• Documentation on elastic.co

reroute

public final CompletableFuture<RerouteResponse> reroute(Function<RerouteRequest.Builder,ObjectBuilder<RerouteRequest>> fn)

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

Parameters:

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

See Also:

• Documentation on elastic.co

reroute

public CompletableFuture<RerouteResponse> reroute()

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

See Also:

• Documentation on elastic.co

state

public CompletableFuture<StateResponse> state(StateRequest request)

Returns a comprehensive information about the state of the cluster.

See Also:

• Documentation on elastic.co

state

public final CompletableFuture<StateResponse> state(Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn)

Returns a comprehensive information about the state of the cluster.

Parameters:

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

See Also:

• Documentation on elastic.co

state

public CompletableFuture<StateResponse> state()

Returns a comprehensive information about the state of the cluster.

See Also:

• Documentation on elastic.co

stats

public CompletableFuture<ClusterStatsResponse> stats(ClusterStatsRequest request)

Returns high-level overview of cluster statistics.

See Also:

• Documentation on elastic.co

stats

public final CompletableFuture<ClusterStatsResponse> stats(Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)

Returns high-level overview of cluster statistics.

Parameters:

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

See Also:

• Documentation on elastic.co

stats

public CompletableFuture<ClusterStatsResponse> stats()

Returns high-level overview of cluster statistics.

See Also:

• Documentation on elastic.co