Package org.opensearch.client.opensearch.cluster

Class OpenSearchClusterClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchClusterClient>

org.opensearch.client.opensearch.cluster.OpenSearchClusterClient

public class OpenSearchClusterClient
extends ApiClient<OpenSearchTransport,OpenSearchClusterClient>

Client for the cluster namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchClusterClient(OpenSearchTransport transport)
OpenSearchClusterClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

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

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSearchClusterClient

public OpenSearchClusterClient(OpenSearchTransport transport)

OpenSearchClusterClient

public OpenSearchClusterClient(OpenSearchTransport transport,
                               @Nullable
                               TransportOptions transportOptions)

Method Detail

withTransportOptions

public OpenSearchClusterClient withTransportOptions(@Nullable
                                                    TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchClusterClient>

allocationExplain

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

Provides explanations for shard allocations in the cluster.

Throws:

java.io.IOException

OpenSearchException

allocationExplain

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

Provides explanations for shard allocations in the cluster.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

allocationExplain

public AllocationExplainResponse allocationExplain()
                                            throws java.io.IOException,
                                                   OpenSearchException

Provides explanations for shard allocations in the cluster.

Throws:

java.io.IOException

OpenSearchException

deleteComponentTemplate

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

Deletes a component template

Throws:

java.io.IOException

OpenSearchException

deleteComponentTemplate

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

Deletes a component template

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteVotingConfigExclusions

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

Clears cluster voting config exclusions.

Throws:

java.io.IOException

OpenSearchException

deleteVotingConfigExclusions

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

Clears cluster voting config exclusions.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

deleteVotingConfigExclusions

public BooleanResponse deleteVotingConfigExclusions()
                                             throws java.io.IOException,
                                                    OpenSearchException

Clears cluster voting config exclusions.

Throws:

java.io.IOException

OpenSearchException

existsComponentTemplate

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

Returns information about whether a particular component template exist

Throws:

java.io.IOException

OpenSearchException

existsComponentTemplate

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

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

OpenSearchException

getComponentTemplate

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

Returns one or more component templates

Throws:

java.io.IOException

OpenSearchException

getComponentTemplate

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

Returns one or more component templates

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

getComponentTemplate

public GetComponentTemplateResponse getComponentTemplate()
                                                  throws java.io.IOException,
                                                         OpenSearchException

Returns one or more component templates

Throws:

java.io.IOException

OpenSearchException

getSettings

public GetClusterSettingsResponse getSettings(GetClusterSettingsRequest request)
                                       throws java.io.IOException,
                                              OpenSearchException

Returns cluster settings.

Throws:

java.io.IOException

OpenSearchException

getSettings

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

Returns cluster settings.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

getSettings

public GetClusterSettingsResponse getSettings()
                                       throws java.io.IOException,
                                              OpenSearchException

Returns cluster settings.

Throws:

java.io.IOException

OpenSearchException

health

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

Returns basic information about the health of the cluster.

Throws:

java.io.IOException

OpenSearchException

health

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

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

OpenSearchException

health

public HealthResponse health()
                      throws java.io.IOException,
                             OpenSearchException

Returns basic information about the health of the cluster.

Throws:

java.io.IOException

OpenSearchException

pendingTasks

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

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

OpenSearchException

pendingTasks

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

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

OpenSearchException

pendingTasks

public PendingTasksResponse pendingTasks()
                                  throws java.io.IOException,
                                         OpenSearchException

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

OpenSearchException

postVotingConfigExclusions

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

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

Throws:

java.io.IOException

OpenSearchException

postVotingConfigExclusions

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

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

OpenSearchException

postVotingConfigExclusions

public BooleanResponse postVotingConfigExclusions()
                                           throws java.io.IOException,
                                                  OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

putComponentTemplate

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

Creates or updates a component template

Throws:

java.io.IOException

OpenSearchException

putComponentTemplate

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

Creates or updates a component template

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

putSettings

public PutClusterSettingsResponse putSettings(PutClusterSettingsRequest request)
                                       throws java.io.IOException,
                                              OpenSearchException

Updates the cluster settings.

Throws:

java.io.IOException

OpenSearchException

putSettings

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

Updates the cluster settings.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

putSettings

public PutClusterSettingsResponse putSettings()
                                       throws java.io.IOException,
                                              OpenSearchException

Updates the cluster settings.

Throws:

java.io.IOException

OpenSearchException

remoteInfo

public RemoteInfoResponse remoteInfo()
                              throws java.io.IOException,
                                     OpenSearchException

Returns the information about configured remote clusters.

Throws:

java.io.IOException

OpenSearchException

reroute

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

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

Throws:

java.io.IOException

OpenSearchException

reroute

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

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

OpenSearchException

reroute

public RerouteResponse reroute()
                        throws java.io.IOException,
                               OpenSearchException

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

Throws:

java.io.IOException

OpenSearchException

state

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

Returns a comprehensive information about the state of the cluster.

Throws:

java.io.IOException

OpenSearchException

state

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

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

OpenSearchException

state

public StateResponse state()
                    throws java.io.IOException,
                           OpenSearchException

Returns a comprehensive information about the state of the cluster.

Throws:

java.io.IOException

OpenSearchException

stats

public ClusterStatsResponse stats(ClusterStatsRequest request)
                           throws java.io.IOException,
                                  OpenSearchException

Returns high-level overview of cluster statistics.

Throws:

java.io.IOException

OpenSearchException

stats

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

Returns high-level overview of cluster statistics.

Parameters:

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

Throws:

java.io.IOException

OpenSearchException

stats

public ClusterStatsResponse stats()
                           throws java.io.IOException,
                                  OpenSearchException

Returns high-level overview of cluster statistics.

Throws:

java.io.IOException

OpenSearchException