Package co.elastic.clients.elasticsearch.cluster

Class ElasticsearchClusterClient

java.lang.Object

co.elastic.clients.base.ApiClient

co.elastic.clients.elasticsearch.cluster.ElasticsearchClusterClient

public class ElasticsearchClusterClient
extends ApiClient

Client for the cluster namespace.

Field Summary

Fields inherited from class co.elastic.clients.base.ApiClient

transport

Constructor Summary

Constructors

Constructor	Description
ElasticsearchClusterClient(Transport transport)

Method Summary

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

Methods inherited from class co.elastic.clients.base.ApiClient

_transport, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

ElasticsearchClusterClient

public ElasticsearchClusterClient(Transport transport)

Method Details

allocationExplain

public AllocationExplainResponse allocationExplain(AllocationExplainRequest request)
                                            throws java.io.IOException

Provides explanations for shard allocations in the cluster.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

allocationExplain

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

Provides explanations for shard allocations in the cluster.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteComponentTemplate

public DeleteComponentTemplateResponse deleteComponentTemplate(DeleteComponentTemplateRequest request)
                                                        throws java.io.IOException

Deletes a component template

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteComponentTemplate

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

Deletes a component template

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteVotingConfigExclusions

public BooleanResponse deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)
                                             throws java.io.IOException

Clears cluster voting config exclusions.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

deleteVotingConfigExclusions

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

Clears cluster voting config exclusions.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

existsComponentTemplate

public BooleanResponse existsComponentTemplate(ExistsComponentTemplateRequest request)
                                        throws java.io.IOException

Returns information about whether a particular component template exist

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

existsComponentTemplate

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

Returns information about whether a particular component template exist

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getComponentTemplate

public GetComponentTemplateResponse getComponentTemplate(GetComponentTemplateRequest request)
                                                  throws java.io.IOException

Returns one or more component templates

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getComponentTemplate

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

Returns one or more component templates

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getSettings

public GetSettingsResponse getSettings(GetSettingsRequest request)
                                throws java.io.IOException

Returns cluster settings.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

getSettings

public final GetSettingsResponse getSettings(java.util.function.Function<GetSettingsRequest.Builder,ObjectBuilder<GetSettingsRequest>> fn)
                                      throws java.io.IOException

Returns cluster settings.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

health

public HealthResponse health(HealthRequest request)
                      throws java.io.IOException

Returns basic information about the health of the cluster.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

health

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

Returns basic information about the health of the cluster.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

pendingTasks

public PendingTasksResponse pendingTasks(PendingTasksRequest request)
                                  throws java.io.IOException

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

See Also:

Documentation on elastic.co

pendingTasks

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

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 freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

postVotingConfigExclusions

public BooleanResponse postVotingConfigExclusions(PostVotingConfigExclusionsRequest request)
                                           throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

postVotingConfigExclusions

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

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putComponentTemplate

public PutComponentTemplateResponse putComponentTemplate(PutComponentTemplateRequest request)
                                                  throws java.io.IOException

Creates or updates a component template

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putComponentTemplate

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

Creates or updates a component template

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putSettings

public PutSettingsResponse putSettings(PutSettingsRequest request)
                                throws java.io.IOException

Updates the cluster settings.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

putSettings

public final PutSettingsResponse putSettings(java.util.function.Function<PutSettingsRequest.Builder,ObjectBuilder<PutSettingsRequest>> fn)
                                      throws java.io.IOException

Updates the cluster settings.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

remoteInfo

public RemoteInfoResponse remoteInfo()
                              throws java.io.IOException

Returns the information about configured remote clusters.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

reroute

public RerouteResponse reroute(RerouteRequest request)
                        throws java.io.IOException

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

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

reroute

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

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

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

state

public StateResponse state(StateRequest request)
                    throws java.io.IOException

Returns a comprehensive information about the state of the cluster.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

state

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

Returns a comprehensive information about the state of the cluster.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

stats

public StatsResponse stats(StatsRequest request)
                    throws java.io.IOException

Returns high-level overview of cluster statistics.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co

stats

public final StatsResponse stats(java.util.function.Function<StatsRequest.Builder,ObjectBuilder<StatsRequest>> fn)
                          throws java.io.IOException

Returns high-level overview of cluster statistics.

Parameters:

fn - a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.

Throws:

java.io.IOException

See Also:

Documentation on elastic.co