Package co.elastic.clients.elasticsearch.cluster

Class ElasticsearchClusterClient

java.lang.Object

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

co.elastic.clients.elasticsearch.cluster.ElasticsearchClusterClient

public class ElasticsearchClusterClient
extends ApiClient<ElasticsearchTransport,ElasticsearchClusterClient>

Client for the cluster namespace.

Field Summary

Fields inherited from class co.elastic.clients.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AllocationExplainResponse	allocationExplain()	Provides explanations for shard allocations in the cluster.
AllocationExplainResponse	allocationExplain(AllocationExplainRequest request)	Provides explanations for shard allocations in the cluster.
final AllocationExplainResponse	allocationExplain(Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn)	Provides explanations for shard allocations in the cluster.
DeleteComponentTemplateResponse	deleteComponentTemplate(DeleteComponentTemplateRequest request)	Deletes component templates.
final DeleteComponentTemplateResponse	deleteComponentTemplate(Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn)	Deletes component templates.
BooleanResponse	deleteVotingConfigExclusions()	Clears cluster voting config exclusions.
BooleanResponse	deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)	Clears cluster voting config exclusions.
final BooleanResponse	deleteVotingConfigExclusions(Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn)	Clears cluster voting config exclusions.
BooleanResponse	existsComponentTemplate(ExistsComponentTemplateRequest request)	Returns information about whether a particular component template exist
final BooleanResponse	existsComponentTemplate(Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn)	Returns information about whether a particular component template exist
GetComponentTemplateResponse	getComponentTemplate()	Retrieves information about component templates.
GetComponentTemplateResponse	getComponentTemplate(GetComponentTemplateRequest request)	Retrieves information about component templates.
final GetComponentTemplateResponse	getComponentTemplate(Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)	Retrieves information about component templates.
GetClusterSettingsResponse	getSettings()	Returns cluster-wide settings.
GetClusterSettingsResponse	getSettings(GetClusterSettingsRequest request)	Returns cluster-wide settings.
final GetClusterSettingsResponse	getSettings(Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)	Returns cluster-wide settings.
HealthResponse	health()	The cluster health API returns a simple status on the health of the cluster.
HealthResponse	health(HealthRequest request)	The cluster health API returns a simple status on the health of the cluster.
final HealthResponse	health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)	The cluster health API returns a simple status on the health of the cluster.
ClusterInfoResponse	info(ClusterInfoRequest request)	Returns different information about the cluster.
final ClusterInfoResponse	info(Function<ClusterInfoRequest.Builder,ObjectBuilder<ClusterInfoRequest>> fn)	Returns different information about the cluster.
PendingTasksResponse	pendingTasks()	Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed.
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 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.
BooleanResponse	postVotingConfigExclusions()	Updates the cluster voting config exclusions by node ids or node names.
BooleanResponse	postVotingConfigExclusions(PostVotingConfigExclusionsRequest request)	Updates the cluster voting config exclusions by node ids or node names.
final BooleanResponse	postVotingConfigExclusions(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.
final PutComponentTemplateResponse	putComponentTemplate(Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)	Creates or updates a component template.
PutClusterSettingsResponse	putSettings()	Updates the cluster settings.
PutClusterSettingsResponse	putSettings(PutClusterSettingsRequest request)	Updates the cluster settings.
final PutClusterSettingsResponse	putSettings(Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)	Updates the cluster settings.
RemoteInfoResponse	remoteInfo()	The cluster remote info API allows you to retrieve all of the configured remote cluster information.
RerouteResponse	reroute()	Allows to manually change the allocation of individual shards in the cluster.
RerouteResponse	reroute(RerouteRequest request)	Allows to manually change the allocation of individual shards in the cluster.
final RerouteResponse	reroute(Function<RerouteRequest.Builder,ObjectBuilder<RerouteRequest>> fn)	Allows to manually change the allocation of individual shards in the cluster.
StateResponse	state()	Returns a comprehensive information about the state of the cluster.
StateResponse	state(StateRequest request)	Returns a comprehensive information about the state of the cluster.
final StateResponse	state(Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn)	Returns a comprehensive information about the state of the cluster.
ClusterStatsResponse	stats()	Returns cluster statistics.
ClusterStatsResponse	stats(ClusterStatsRequest request)	Returns cluster statistics.
final ClusterStatsResponse	stats(Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)	Returns cluster statistics.
ElasticsearchClusterClient	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

ElasticsearchClusterClient

public ElasticsearchClusterClient(ElasticsearchTransport transport)

ElasticsearchClusterClient

public ElasticsearchClusterClient(ElasticsearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public ElasticsearchClusterClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchClusterClient>

allocationExplain

public AllocationExplainResponse allocationExplain(AllocationExplainRequest request)
                                            throws IOException,
ElasticsearchException

Provides explanations for shard allocations in the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

allocationExplain

public final AllocationExplainResponse allocationExplain(Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn)
                                                  throws IOException,
ElasticsearchException

Provides explanations for shard allocations in the cluster.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

allocationExplain

public AllocationExplainResponse allocationExplain()
                                            throws IOException,
ElasticsearchException

Provides explanations for shard allocations in the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteComponentTemplate

public DeleteComponentTemplateResponse deleteComponentTemplate(DeleteComponentTemplateRequest request)
                                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteComponentTemplate

public final DeleteComponentTemplateResponse deleteComponentTemplate(Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn)
                                                              throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteVotingConfigExclusions

public BooleanResponse deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)
                                             throws IOException,
ElasticsearchException

Clears cluster voting config exclusions.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteVotingConfigExclusions

public final BooleanResponse deleteVotingConfigExclusions(Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn)
                                                   throws IOException,
ElasticsearchException

Clears cluster voting config exclusions.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

deleteVotingConfigExclusions

public BooleanResponse deleteVotingConfigExclusions()
                                             throws IOException,
ElasticsearchException

Clears cluster voting config exclusions.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsComponentTemplate

public BooleanResponse existsComponentTemplate(ExistsComponentTemplateRequest request)
                                        throws IOException,
ElasticsearchException

Returns information about whether a particular component template exist

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

existsComponentTemplate

public final BooleanResponse existsComponentTemplate(Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn)
                                              throws IOException,
ElasticsearchException

Returns information about whether a particular component template exist

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getComponentTemplate

public GetComponentTemplateResponse getComponentTemplate(GetComponentTemplateRequest request)
                                                  throws IOException,
ElasticsearchException

Retrieves information about component templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getComponentTemplate

public final GetComponentTemplateResponse getComponentTemplate(Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)
                                                        throws IOException,
ElasticsearchException

Retrieves information about component templates.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getComponentTemplate

public GetComponentTemplateResponse getComponentTemplate()
                                                  throws IOException,
ElasticsearchException

Retrieves information about component templates.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSettings

public GetClusterSettingsResponse getSettings(GetClusterSettingsRequest request)
                                       throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSettings

public final GetClusterSettingsResponse getSettings(Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)
                                             throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

getSettings

public GetClusterSettingsResponse getSettings()
                                       throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

health

public HealthResponse health(HealthRequest request)
                      throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

health

public final HealthResponse health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)
                            throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

health

public HealthResponse health()
                      throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

info

public ClusterInfoResponse info(ClusterInfoRequest request)
                         throws IOException,
ElasticsearchException

Returns different information about the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

info

public final ClusterInfoResponse info(Function<ClusterInfoRequest.Builder,ObjectBuilder<ClusterInfoRequest>> fn)
                               throws IOException,
ElasticsearchException

Returns different information about the cluster.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

pendingTasks

public PendingTasksResponse pendingTasks(PendingTasksRequest request)
                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

pendingTasks

public final PendingTasksResponse pendingTasks(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)
                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

pendingTasks

public PendingTasksResponse pendingTasks()
                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postVotingConfigExclusions

public BooleanResponse postVotingConfigExclusions(PostVotingConfigExclusionsRequest request)
                                           throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postVotingConfigExclusions

public final BooleanResponse postVotingConfigExclusions(Function<PostVotingConfigExclusionsRequest.Builder,ObjectBuilder<PostVotingConfigExclusionsRequest>> fn)
                                                 throws 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:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

postVotingConfigExclusions

public BooleanResponse postVotingConfigExclusions()
                                           throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putComponentTemplate

public PutComponentTemplateResponse putComponentTemplate(PutComponentTemplateRequest request)
                                                  throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putComponentTemplate

public final PutComponentTemplateResponse putComponentTemplate(Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)
                                                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSettings

public PutClusterSettingsResponse putSettings(PutClusterSettingsRequest request)
                                       throws IOException,
ElasticsearchException

Updates the cluster settings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSettings

public final PutClusterSettingsResponse putSettings(Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)
                                             throws IOException,
ElasticsearchException

Updates the cluster settings.

Parameters:

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

putSettings

public PutClusterSettingsResponse putSettings()
                                       throws IOException,
ElasticsearchException

Updates the cluster settings.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

remoteInfo

public RemoteInfoResponse remoteInfo()
                              throws IOException,
ElasticsearchException

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.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reroute

public RerouteResponse reroute(RerouteRequest request)
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reroute

public final RerouteResponse reroute(Function<RerouteRequest.Builder,ObjectBuilder<RerouteRequest>> fn)
                              throws 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:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

reroute

public RerouteResponse reroute()
                        throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

state

public StateResponse state(StateRequest request)
                    throws IOException,
ElasticsearchException

Returns a comprehensive information about the state of the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

state

public final StateResponse state(Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn)
                          throws 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:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

state

public StateResponse state()
                    throws IOException,
ElasticsearchException

Returns a comprehensive information about the state of the cluster.

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public ClusterStatsResponse stats(ClusterStatsRequest request)
                           throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public final ClusterStatsResponse stats(Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)
                                 throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co

stats

public ClusterStatsResponse stats()
                           throws IOException,
ElasticsearchException

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

Throws:

IOException

ElasticsearchException

See Also:

• Documentation on elastic.co