Package co.elastic.clients.elasticsearch.cluster

Class ElasticsearchClusterAsyncClient

java.lang.Object

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

co.elastic.clients.elasticsearch.cluster.ElasticsearchClusterAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable

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)	Delete component templates.
final CompletableFuture<DeleteComponentTemplateResponse>	deleteComponentTemplate(Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn)	Delete component templates.
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)	Check component templates.
final CompletableFuture<BooleanResponse>	existsComponentTemplate(Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn)	Check component templates.
CompletableFuture<GetComponentTemplateResponse>	getComponentTemplate()	Get component templates.
CompletableFuture<GetComponentTemplateResponse>	getComponentTemplate(GetComponentTemplateRequest request)	Get component templates.
final CompletableFuture<GetComponentTemplateResponse>	getComponentTemplate(Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)	Get component templates.
CompletableFuture<GetClusterSettingsResponse>	getSettings()	Returns cluster-wide settings.
CompletableFuture<GetClusterSettingsResponse>	getSettings(GetClusterSettingsRequest request)	Returns cluster-wide settings.
final CompletableFuture<GetClusterSettingsResponse>	getSettings(Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)	Returns cluster-wide settings.
CompletableFuture<HealthResponse>	health()	The cluster health API returns a simple status on the health of the cluster.
CompletableFuture<HealthResponse>	health(HealthRequest request)	The cluster health API returns a simple status on the health of the cluster.
final CompletableFuture<HealthResponse>	health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)	The cluster health API returns a simple status on the health of the cluster.
CompletableFuture<ClusterInfoResponse>	info(ClusterInfoRequest request)	Get cluster info.
final CompletableFuture<ClusterInfoResponse>	info(Function<ClusterInfoRequest.Builder,ObjectBuilder<ClusterInfoRequest>> fn)	Get cluster info.
CompletableFuture<PendingTasksResponse>	pendingTasks()	Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
CompletableFuture<PendingTasksResponse>	pendingTasks(PendingTasksRequest request)	Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
final CompletableFuture<PendingTasksResponse>	pendingTasks(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)	Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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)	Create or update a component template.
final CompletableFuture<PutComponentTemplateResponse>	putComponentTemplate(Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)	Create or update 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()	The cluster remote info API allows you to retrieve all of the configured remote cluster information.
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 cluster statistics.
CompletableFuture<ClusterStatsResponse>	stats(ClusterStatsRequest request)	Returns cluster statistics.
final CompletableFuture<ClusterStatsResponse>	stats(Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)	Returns 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, close, 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)

Delete component templates. Deletes component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

See Also:

• Documentation on elastic.co

deleteComponentTemplate

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

Delete component templates. Deletes component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

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)

Check component templates. Returns information about whether a particular component template exists.

See Also:

• Documentation on elastic.co

existsComponentTemplate

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

Check component templates. Returns information about whether a particular component template exists.

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)

Get component templates. Retrieves information about component templates.

See Also:

• Documentation on elastic.co

getComponentTemplate

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

Get component templates. Retrieves information about 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()

Get component templates. Retrieves information about component templates.

See Also:

• Documentation on elastic.co

getSettings

public CompletableFuture<GetClusterSettingsResponse> getSettings(GetClusterSettingsRequest request)

Returns cluster-wide settings. By default, it returns only settings that have been explicitly defined.

See Also:

• Documentation on elastic.co

getSettings

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

Returns cluster-wide settings. By default, it returns only settings that have been explicitly defined.

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-wide settings. By default, it returns only settings that have been explicitly defined.

See Also:

• Documentation on elastic.co

health

public CompletableFuture<HealthResponse> health(HealthRequest request)

The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.

See Also:

• Documentation on elastic.co

health

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

The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.

Parameters:

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

See Also:

• Documentation on elastic.co

health

public CompletableFuture<HealthResponse> health()

The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices. The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.

See Also:

• Documentation on elastic.co

info

public CompletableFuture<ClusterInfoResponse> info(ClusterInfoRequest request)

Get cluster info. Returns basic information about the cluster.

See Also:

• Documentation on elastic.co

info

public final CompletableFuture<ClusterInfoResponse> info(Function<ClusterInfoRequest.Builder,ObjectBuilder<ClusterInfoRequest>> fn)

Get cluster info. Returns basic information about the cluster.

Parameters:

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

See Also:

• Documentation on elastic.co

pendingTasks

public CompletableFuture<PendingTasksResponse> pendingTasks(PendingTasksRequest request)

Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.

See Also:

• Documentation on elastic.co

pendingTasks

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

Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.

Parameters:

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

See Also:

• Documentation on elastic.co

pendingTasks

public CompletableFuture<PendingTasksResponse> pendingTasks()

Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.

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)

Create or update a component template. Creates or updates a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s composed_of list. Component templates are only applied to new data streams and indices as part of a matching index template.

Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.

Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.

You can use C-style /* *\/ block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.

See Also:

• Documentation on elastic.co

putComponentTemplate

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

Create or update a component template. Creates or updates a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s composed_of list. Component templates are only applied to new data streams and indices as part of a matching index template.

Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.

Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.

You can use C-style /* *\/ block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.

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()

The cluster remote info API allows you to retrieve all of the configured remote cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias.

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 cluster statistics. It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

See Also:

• Documentation on elastic.co

stats

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

Returns cluster statistics. It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

Parameters:

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

See Also:

• Documentation on elastic.co

stats

public CompletableFuture<ClusterStatsResponse> stats()

Returns cluster statistics. It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

See Also:

• Documentation on elastic.co