Package org.opensearch.client.opensearch.cluster

Class OpenSearchClusterAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.cluster.OpenSearchClusterAsyncClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class OpenSearchClusterAsyncClient
extends ApiClient<OpenSearchTransport,OpenSearchClusterAsyncClient>

Client for the cluster namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final CompletableFuture<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 CompletableFuture<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.
CompletableFuture<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 CompletableFuture<DeleteComponentTemplateResponse>	deleteComponentTemplate(Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn)	Deletes a component template.
CompletableFuture<DeleteComponentTemplateResponse>	deleteComponentTemplate(DeleteComponentTemplateRequest request)	Deletes a component template.
final CompletableFuture<BooleanResponse>	deleteVotingConfigExclusions()	Clears any cluster voting configuration exclusions.
final CompletableFuture<BooleanResponse>	deleteVotingConfigExclusions(Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn)	Clears any cluster voting configuration exclusions.
CompletableFuture<BooleanResponse>	deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)	Clears any cluster voting configuration exclusions.
final CompletableFuture<BooleanResponse>	existsComponentTemplate(Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn)	Returns information about whether a particular component template exist.
CompletableFuture<BooleanResponse>	existsComponentTemplate(ExistsComponentTemplateRequest request)	Returns information about whether a particular component template exist.
final CompletableFuture<GetComponentTemplateResponse>	getComponentTemplate()	Returns one or more component templates.
final CompletableFuture<GetComponentTemplateResponse>	getComponentTemplate(Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)	Returns one or more component templates.
CompletableFuture<GetComponentTemplateResponse>	getComponentTemplate(GetComponentTemplateRequest request)	Returns one or more component templates.
final CompletableFuture<GetClusterSettingsResponse>	getSettings()	Returns cluster settings.
final CompletableFuture<GetClusterSettingsResponse>	getSettings(Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)	Returns cluster settings.
CompletableFuture<GetClusterSettingsResponse>	getSettings(GetClusterSettingsRequest request)	Returns cluster settings.
final CompletableFuture<HealthResponse>	health()	Returns basic information about the health of the cluster.
final CompletableFuture<HealthResponse>	health(Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)	Returns basic information about the health of the cluster.
CompletableFuture<HealthResponse>	health(HealthRequest request)	Returns basic information about the health of the cluster.
final CompletableFuture<PendingTasksResponse>	pendingTasks()	Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.
final CompletableFuture<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.
CompletableFuture<PendingTasksResponse>	pendingTasks(PendingTasksRequest request)	Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.
final CompletableFuture<BooleanResponse>	postVotingConfigExclusions()	Updates the cluster voting configuration by excluding certain node IDs or names.
final CompletableFuture<BooleanResponse>	postVotingConfigExclusions(Function<PostVotingConfigExclusionsRequest.Builder,ObjectBuilder<PostVotingConfigExclusionsRequest>> fn)	Updates the cluster voting configuration by excluding certain node IDs or names.
CompletableFuture<BooleanResponse>	postVotingConfigExclusions(PostVotingConfigExclusionsRequest request)	Updates the cluster voting configuration by excluding certain node IDs or names.
final CompletableFuture<PutComponentTemplateResponse>	putComponentTemplate(Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)	Creates or updates a component template.
CompletableFuture<PutComponentTemplateResponse>	putComponentTemplate(PutComponentTemplateRequest request)	Creates or updates a component template.
final CompletableFuture<PutClusterSettingsResponse>	putSettings()	Updates the cluster settings.
final CompletableFuture<PutClusterSettingsResponse>	putSettings(Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)	Updates the cluster settings.
CompletableFuture<PutClusterSettingsResponse>	putSettings(PutClusterSettingsRequest request)	Updates the cluster settings.
final CompletableFuture<RemoteInfoResponse>	remoteInfo()	Returns the information about configured remote clusters.
final CompletableFuture<RemoteInfoResponse>	remoteInfo(Function<RemoteInfoRequest.Builder,ObjectBuilder<RemoteInfoRequest>> fn)	Returns the information about configured remote clusters.
CompletableFuture<RemoteInfoResponse>	remoteInfo(RemoteInfoRequest request)	Returns the information about configured remote clusters.
final CompletableFuture<RerouteResponse>	reroute()	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<RerouteResponse>	reroute(RerouteRequest request)	Allows to manually change the allocation of individual shards in the cluster.
final CompletableFuture<StateResponse>	state()	Returns comprehensive information about the state of the cluster.
final CompletableFuture<StateResponse>	state(Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn)	Returns comprehensive information about the state of the cluster.
CompletableFuture<StateResponse>	state(StateRequest request)	Returns comprehensive information about the state of the cluster.
final CompletableFuture<ClusterStatsResponse>	stats()	Returns a high-level overview of cluster statistics.
final CompletableFuture<ClusterStatsResponse>	stats(Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn)	Returns a high-level overview of cluster statistics.
CompletableFuture<ClusterStatsResponse>	stats(ClusterStatsRequest request)	Returns a high-level overview of cluster statistics.
OpenSearchClusterAsyncClient	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

OpenSearchClusterAsyncClient

public OpenSearchClusterAsyncClient(OpenSearchTransport transport)

OpenSearchClusterAsyncClient

public OpenSearchClusterAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchClusterAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchClusterAsyncClient>

allocationExplain

public CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<DeleteComponentTemplateResponse> deleteComponentTemplate(DeleteComponentTemplateRequest request)
                                                                           throws IOException,
OpenSearchException

Deletes a component template.

Throws:

IOException

OpenSearchException

deleteComponentTemplate

public final CompletableFuture<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 CompletableFuture<BooleanResponse> deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)
                                                                throws IOException,
OpenSearchException

Clears any cluster voting configuration exclusions.

Throws:

IOException

OpenSearchException

deleteVotingConfigExclusions

public final CompletableFuture<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 CompletableFuture<BooleanResponse> deleteVotingConfigExclusions()
                                                                      throws IOException,
OpenSearchException

Clears any cluster voting configuration exclusions.

Throws:

IOException

OpenSearchException

existsComponentTemplate

public CompletableFuture<BooleanResponse> existsComponentTemplate(ExistsComponentTemplateRequest request)
                                                           throws IOException,
OpenSearchException

Returns information about whether a particular component template exist.

Throws:

IOException

OpenSearchException

existsComponentTemplate

public final CompletableFuture<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 CompletableFuture<GetComponentTemplateResponse> getComponentTemplate(GetComponentTemplateRequest request)
                                                                     throws IOException,
OpenSearchException

Returns one or more component templates.

Throws:

IOException

OpenSearchException

getComponentTemplate

public final CompletableFuture<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 CompletableFuture<GetComponentTemplateResponse> getComponentTemplate()
                                                                           throws IOException,
OpenSearchException

Returns one or more component templates.

Throws:

IOException

OpenSearchException

getSettings

public CompletableFuture<GetClusterSettingsResponse> getSettings(GetClusterSettingsRequest request)
                                                          throws IOException,
OpenSearchException

Returns cluster settings.

Throws:

IOException

OpenSearchException

getSettings

public final CompletableFuture<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 CompletableFuture<GetClusterSettingsResponse> getSettings()
                                                                throws IOException,
OpenSearchException

Returns cluster settings.

Throws:

IOException

OpenSearchException

health

public CompletableFuture<HealthResponse> health(HealthRequest request)
                                         throws IOException,
OpenSearchException

Returns basic information about the health of the cluster.

Throws:

IOException

OpenSearchException

health

public final CompletableFuture<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 CompletableFuture<HealthResponse> health()
                                               throws IOException,
OpenSearchException

Returns basic information about the health of the cluster.

Throws:

IOException

OpenSearchException

pendingTasks

public CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<BooleanResponse> postVotingConfigExclusions()
                                                                    throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

putComponentTemplate

public CompletableFuture<PutComponentTemplateResponse> putComponentTemplate(PutComponentTemplateRequest request)
                                                                     throws IOException,
OpenSearchException

Creates or updates a component template.

Throws:

IOException

OpenSearchException

putComponentTemplate

public final CompletableFuture<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 CompletableFuture<PutClusterSettingsResponse> putSettings(PutClusterSettingsRequest request)
                                                          throws IOException,
OpenSearchException

Updates the cluster settings.

Throws:

IOException

OpenSearchException

putSettings

public final CompletableFuture<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 CompletableFuture<PutClusterSettingsResponse> putSettings()
                                                                throws IOException,
OpenSearchException

Updates the cluster settings.

Throws:

IOException

OpenSearchException

remoteInfo

public CompletableFuture<RemoteInfoResponse> remoteInfo(RemoteInfoRequest request)
                                                 throws IOException,
OpenSearchException

Returns the information about configured remote clusters.

Throws:

IOException

OpenSearchException

remoteInfo

public final CompletableFuture<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 CompletableFuture<RemoteInfoResponse> remoteInfo()
                                                       throws IOException,
OpenSearchException

Returns the information about configured remote clusters.

Throws:

IOException

OpenSearchException

reroute

public CompletableFuture<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 CompletableFuture<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 CompletableFuture<RerouteResponse> reroute()
                                                 throws IOException,
OpenSearchException

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

Throws:

IOException

OpenSearchException

state

public CompletableFuture<StateResponse> state(StateRequest request)
                                       throws IOException,
OpenSearchException

Returns comprehensive information about the state of the cluster.

Throws:

IOException

OpenSearchException

state

public final CompletableFuture<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 CompletableFuture<StateResponse> state()
                                             throws IOException,
OpenSearchException

Returns comprehensive information about the state of the cluster.

Throws:

IOException

OpenSearchException

stats

public CompletableFuture<ClusterStatsResponse> stats(ClusterStatsRequest request)
                                              throws IOException,
OpenSearchException

Returns a high-level overview of cluster statistics.

Throws:

IOException

OpenSearchException

stats

public final CompletableFuture<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 CompletableFuture<ClusterStatsResponse> stats()
                                                    throws IOException,
OpenSearchException

Returns a high-level overview of cluster statistics.

Throws:

IOException

OpenSearchException