Package org.opensearch.client.opensearch.cluster

Class OpenSearchClusterClient

java.lang.Object

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

org.opensearch.client.opensearch.cluster.OpenSearchClusterClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
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
final AllocationExplainResponse	allocationExplain()	Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.
final AllocationExplainResponse	allocationExplain(Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn)	Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.
AllocationExplainResponse	allocationExplain(AllocationExplainRequest request)	Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.
final DeleteComponentTemplateResponse	deleteComponentTemplate(Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn)	Deletes a component template.
DeleteComponentTemplateResponse	deleteComponentTemplate(DeleteComponentTemplateRequest request)	Deletes a component template.
final BooleanResponse	deleteVotingConfigExclusions()	Clears any cluster voting configuration exclusions.
final BooleanResponse	deleteVotingConfigExclusions(Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn)	Clears any cluster voting configuration exclusions.
BooleanResponse	deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)	Clears any cluster voting configuration exclusions.
final BooleanResponse	existsComponentTemplate(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.
final GetComponentTemplateResponse	getComponentTemplate()	Returns one or more component templates.
final GetComponentTemplateResponse	getComponentTemplate(Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)	Returns one or more component templates.
GetComponentTemplateResponse	getComponentTemplate(GetComponentTemplateRequest request)	Returns one or more component templates.
final GetClusterSettingsResponse	getSettings()	Returns cluster settings.
final GetClusterSettingsResponse	getSettings(Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)	Returns cluster settings.
GetClusterSettingsResponse	getSettings(GetClusterSettingsRequest request)	Returns cluster settings.
final HealthResponse	health()	Returns basic information about the health of the cluster.
final HealthResponse	health(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.
final PendingTasksResponse	pendingTasks()	Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.
final PendingTasksResponse	pendingTasks(Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)	Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.
PendingTasksResponse	pendingTasks(PendingTasksRequest request)	Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.
final BooleanResponse	postVotingConfigExclusions()	Updates the cluster voting configuration by excluding certain node IDs or names.
final BooleanResponse	postVotingConfigExclusions(Function<PostVotingConfigExclusionsRequest.Builder,ObjectBuilder<PostVotingConfigExclusionsRequest>> fn)	Updates the cluster voting configuration by excluding certain node IDs or names.
BooleanResponse	postVotingConfigExclusions(PostVotingConfigExclusionsRequest request)	Updates the cluster voting configuration by excluding certain node IDs or names.
final PutComponentTemplateResponse	putComponentTemplate(Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)	Creates or updates a component template.
PutComponentTemplateResponse	putComponentTemplate(PutComponentTemplateRequest request)	Creates or updates a component template.
final PutClusterSettingsResponse	putSettings()	Updates the cluster settings.
final PutClusterSettingsResponse	putSettings(Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)	Updates the cluster settings.
PutClusterSettingsResponse	putSettings(PutClusterSettingsRequest request)	Updates the cluster settings.
final RemoteInfoResponse	remoteInfo()	Returns the information about configured remote clusters.
final RemoteInfoResponse	remoteInfo(Function<RemoteInfoRequest.Builder,ObjectBuilder<RemoteInfoRequest>> fn)	Returns the information about configured remote clusters.
RemoteInfoResponse	remoteInfo(RemoteInfoRequest request)	Returns the information about configured remote clusters.
final RerouteResponse	reroute()	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.
RerouteResponse	reroute(RerouteRequest request)	Allows to manually change the allocation of individual shards in the cluster.
final StateResponse	state()	Returns comprehensive information about the state of the cluster.
final StateResponse	state(Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn)	Returns comprehensive information about the state of the cluster.
StateResponse	state(StateRequest request)	Returns comprehensive information about the state of the cluster.
final ClusterStatsResponse	stats()	Returns a high-level overview of cluster statistics.
final ClusterStatsResponse	stats(Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)	Returns a high-level overview of cluster statistics.
ClusterStatsResponse	stats(ClusterStatsRequest request)	Returns a 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 Details

OpenSearchClusterClient

public OpenSearchClusterClient(OpenSearchTransport transport)

OpenSearchClusterClient

public OpenSearchClusterClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

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 IOException,
OpenSearchException

Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.

Throws:

IOException

OpenSearchException

allocationExplain

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

Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.

Parameters:

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

Throws:

IOException

OpenSearchException

allocationExplain

public final AllocationExplainResponse allocationExplain()
                                                  throws IOException,
OpenSearchException

Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.

Throws:

IOException

OpenSearchException

deleteComponentTemplate

public DeleteComponentTemplateResponse deleteComponentTemplate(DeleteComponentTemplateRequest request)
                                                        throws IOException,
OpenSearchException

Deletes a component template.

Throws:

IOException

OpenSearchException

deleteComponentTemplate

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

Deletes a component template.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteVotingConfigExclusions

public BooleanResponse deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)
                                             throws IOException,
OpenSearchException

Clears any cluster voting configuration exclusions.

Throws:

IOException

OpenSearchException

deleteVotingConfigExclusions

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

Clears any cluster voting configuration exclusions.

Parameters:

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

Throws:

IOException

OpenSearchException

deleteVotingConfigExclusions

public final BooleanResponse deleteVotingConfigExclusions()
                                                   throws IOException,
OpenSearchException

Clears any cluster voting configuration exclusions.

Throws:

IOException

OpenSearchException

existsComponentTemplate

public BooleanResponse existsComponentTemplate(ExistsComponentTemplateRequest request)
                                        throws IOException,
OpenSearchException

Returns information about whether a particular component template exist.

Throws:

IOException

OpenSearchException

existsComponentTemplate

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

Returns information about whether a particular component template exist.

Parameters:

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

Throws:

IOException

OpenSearchException

getComponentTemplate

public GetComponentTemplateResponse getComponentTemplate(GetComponentTemplateRequest request)
                                                  throws IOException,
OpenSearchException

Returns one or more component templates.

Throws:

IOException

OpenSearchException

getComponentTemplate

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

Returns one or more component templates.

Parameters:

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

Throws:

IOException

OpenSearchException

getComponentTemplate

public final GetComponentTemplateResponse getComponentTemplate()
                                                        throws IOException,
OpenSearchException

Returns one or more component templates.

Throws:

IOException

OpenSearchException

getSettings

public GetClusterSettingsResponse getSettings(GetClusterSettingsRequest request)
                                       throws IOException,
OpenSearchException

Returns cluster settings.

Throws:

IOException

OpenSearchException

getSettings

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

Returns cluster settings.

Parameters:

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

Throws:

IOException

OpenSearchException

getSettings

public final GetClusterSettingsResponse getSettings()
                                             throws IOException,
OpenSearchException

Returns cluster settings.

Throws:

IOException

OpenSearchException

health

public HealthResponse health(HealthRequest request)
                      throws IOException,
OpenSearchException

Returns basic information about the health of the cluster.

Throws:

IOException

OpenSearchException

health

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

Returns basic information about the health of the cluster.

Parameters:

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

Throws:

IOException

OpenSearchException

health

public final HealthResponse health()
                            throws IOException,
OpenSearchException

Returns basic information about the health of the cluster.

Throws:

IOException

OpenSearchException

pendingTasks

public PendingTasksResponse pendingTasks(PendingTasksRequest request)
                                  throws IOException,
OpenSearchException

Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.

Throws:

IOException

OpenSearchException

pendingTasks

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

Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.

Parameters:

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

Throws:

IOException

OpenSearchException

pendingTasks

public final PendingTasksResponse pendingTasks()
                                        throws IOException,
OpenSearchException

Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.

Throws:

IOException

OpenSearchException

postVotingConfigExclusions

public BooleanResponse postVotingConfigExclusions(PostVotingConfigExclusionsRequest request)
                                           throws IOException,
OpenSearchException

Updates the cluster voting configuration by excluding certain node IDs or names.

Throws:

IOException

OpenSearchException

postVotingConfigExclusions

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

Updates the cluster voting configuration by excluding certain node IDs or names.

Parameters:

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

Throws:

IOException

OpenSearchException

postVotingConfigExclusions

public final BooleanResponse postVotingConfigExclusions()
                                                 throws IOException,
OpenSearchException

Updates the cluster voting configuration by excluding certain node IDs or names.

Throws:

IOException

OpenSearchException

putComponentTemplate

public PutComponentTemplateResponse putComponentTemplate(PutComponentTemplateRequest request)
                                                  throws IOException,
OpenSearchException

Creates or updates a component template.

Throws:

IOException

OpenSearchException

putComponentTemplate

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

Creates or updates a component template.

Parameters:

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

Throws:

IOException

OpenSearchException

putSettings

public PutClusterSettingsResponse putSettings(PutClusterSettingsRequest request)
                                       throws IOException,
OpenSearchException

Updates the cluster settings.

Throws:

IOException

OpenSearchException

putSettings

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

Updates the cluster settings.

Parameters:

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

Throws:

IOException

OpenSearchException

putSettings

public final PutClusterSettingsResponse putSettings()
                                             throws IOException,
OpenSearchException

Updates the cluster settings.

Throws:

IOException

OpenSearchException

remoteInfo

public RemoteInfoResponse remoteInfo(RemoteInfoRequest request)
                              throws IOException,
OpenSearchException

Returns the information about configured remote clusters.

Throws:

IOException

OpenSearchException

remoteInfo

public final RemoteInfoResponse remoteInfo(Function<RemoteInfoRequest.Builder,ObjectBuilder<RemoteInfoRequest>> fn)
                                    throws IOException,
OpenSearchException

Returns the information about configured remote clusters.

Parameters:

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

Throws:

IOException

OpenSearchException

remoteInfo

public final RemoteInfoResponse remoteInfo()
                                    throws IOException,
OpenSearchException

Returns the information about configured remote clusters.

Throws:

IOException

OpenSearchException

reroute

public RerouteResponse reroute(RerouteRequest request)
                        throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

reroute

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

IOException

OpenSearchException

reroute

public final RerouteResponse reroute()
                              throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

state

public StateResponse state(StateRequest request)
                    throws IOException,
OpenSearchException

Returns comprehensive information about the state of the cluster.

Throws:

IOException

OpenSearchException

state

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

Returns comprehensive information about the state of the cluster.

Parameters:

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

Throws:

IOException

OpenSearchException

state

public final StateResponse state()
                          throws IOException,
OpenSearchException

Returns comprehensive information about the state of the cluster.

Throws:

IOException

OpenSearchException

stats

public ClusterStatsResponse stats(ClusterStatsRequest request)
                           throws IOException,
OpenSearchException

Returns a high-level overview of cluster statistics.

Throws:

IOException

OpenSearchException

stats

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

Returns a high-level overview of cluster statistics.

Parameters:

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

Throws:

IOException

OpenSearchException

stats

public final ClusterStatsResponse stats()
                                 throws IOException,
OpenSearchException

Returns a high-level overview of cluster statistics.

Throws:

IOException

OpenSearchException