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
ConstructorsConstructorDescriptionOpenSearchClusterAsyncClient(OpenSearchTransport transport) OpenSearchClusterAsyncClient(OpenSearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptionExplains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.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.Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.deleteComponentTemplate(Function<DeleteComponentTemplateRequest.Builder, ObjectBuilder<DeleteComponentTemplateRequest>> fn) Deletes a component template.Deletes a component template.final CompletableFuture<BooleanResponse> Clears any cluster voting configuration exclusions.final CompletableFuture<BooleanResponse> deleteVotingConfigExclusions(Function<DeleteVotingConfigExclusionsRequest.Builder, ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn) Clears any cluster voting configuration exclusions.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.Returns information about whether a particular component template exist.Returns one or more component templates.getComponentTemplate(Function<GetComponentTemplateRequest.Builder, ObjectBuilder<GetComponentTemplateRequest>> fn) Returns one or more component templates.Returns one or more component templates.Returns cluster settings.getSettings(Function<GetClusterSettingsRequest.Builder, ObjectBuilder<GetClusterSettingsRequest>> fn) Returns cluster settings.getSettings(GetClusterSettingsRequest request) Returns cluster settings.final CompletableFuture<HealthResponse> health()Returns basic information about the health of the cluster.final CompletableFuture<HealthResponse> Returns basic information about the health of the cluster.health(HealthRequest request) Returns basic information about the health of the cluster.Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.pendingTasks(PendingTasksRequest request) Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.final CompletableFuture<BooleanResponse> 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.Updates the cluster voting configuration by excluding certain node IDs or names.putComponentTemplate(Function<PutComponentTemplateRequest.Builder, ObjectBuilder<PutComponentTemplateRequest>> fn) Creates or updates a component template.Creates or updates a component template.Updates the cluster settings.putSettings(Function<PutClusterSettingsRequest.Builder, ObjectBuilder<PutClusterSettingsRequest>> fn) Updates the cluster settings.putSettings(PutClusterSettingsRequest request) Updates the cluster settings.Returns the information about configured remote clusters.Returns the information about configured remote clusters.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> Allows to manually change the allocation of individual shards in the cluster.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> Returns comprehensive information about the state of the cluster.state(StateRequest request) Returns comprehensive information about the state of the cluster.stats()Returns a high-level overview of cluster statistics.Returns a high-level overview of cluster statistics.stats(ClusterStatsRequest request) Returns a high-level overview of cluster statistics.withTransportOptions(TransportOptions transportOptions) Creates a new client with some request optionsMethods inherited from class org.opensearch.client.ApiClient
_transport, _transportOptions, getDeserializer
-
Constructor Details
-
OpenSearchClusterAsyncClient
-
OpenSearchClusterAsyncClient
public OpenSearchClusterAsyncClient(OpenSearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
public OpenSearchClusterAsyncClient withTransportOptions(@Nullable TransportOptions transportOptions) Description copied from class:ApiClientCreates a new client with some request options- Specified by:
withTransportOptionsin classApiClient<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:
IOExceptionOpenSearchException
-
allocationExplain
public final CompletableFuture<AllocationExplainResponse> allocationExplain(Function<AllocationExplainRequest.Builder, ObjectBuilder<AllocationExplainRequest>> fn) throws IOException, OpenSearchExceptionExplains 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 theAllocationExplainRequest- Throws:
IOExceptionOpenSearchException
-
allocationExplain
public final CompletableFuture<AllocationExplainResponse> allocationExplain() throws IOException, OpenSearchExceptionExplains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.- Throws:
IOExceptionOpenSearchException
-
deleteComponentTemplate
public CompletableFuture<DeleteComponentTemplateResponse> deleteComponentTemplate(DeleteComponentTemplateRequest request) throws IOException, OpenSearchException Deletes a component template.- Throws:
IOExceptionOpenSearchException
-
deleteComponentTemplate
public final CompletableFuture<DeleteComponentTemplateResponse> deleteComponentTemplate(Function<DeleteComponentTemplateRequest.Builder, ObjectBuilder<DeleteComponentTemplateRequest>> fn) throws IOException, OpenSearchExceptionDeletes a component template.- Parameters:
fn- a function that initializes a builder to create theDeleteComponentTemplateRequest- Throws:
IOExceptionOpenSearchException
-
deleteVotingConfigExclusions
public CompletableFuture<BooleanResponse> deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request) throws IOException, OpenSearchException Clears any cluster voting configuration exclusions.- Throws:
IOExceptionOpenSearchException
-
deleteVotingConfigExclusions
public final CompletableFuture<BooleanResponse> deleteVotingConfigExclusions(Function<DeleteVotingConfigExclusionsRequest.Builder, ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn) throws IOException, OpenSearchExceptionClears any cluster voting configuration exclusions.- Parameters:
fn- a function that initializes a builder to create theDeleteVotingConfigExclusionsRequest- Throws:
IOExceptionOpenSearchException
-
deleteVotingConfigExclusions
public final CompletableFuture<BooleanResponse> deleteVotingConfigExclusions() throws IOException, OpenSearchExceptionClears any cluster voting configuration exclusions.- Throws:
IOExceptionOpenSearchException
-
existsComponentTemplate
public CompletableFuture<BooleanResponse> existsComponentTemplate(ExistsComponentTemplateRequest request) throws IOException, OpenSearchException Returns information about whether a particular component template exist.- Throws:
IOExceptionOpenSearchException
-
existsComponentTemplate
public final CompletableFuture<BooleanResponse> existsComponentTemplate(Function<ExistsComponentTemplateRequest.Builder, ObjectBuilder<ExistsComponentTemplateRequest>> fn) throws IOException, OpenSearchExceptionReturns information about whether a particular component template exist.- Parameters:
fn- a function that initializes a builder to create theExistsComponentTemplateRequest- Throws:
IOExceptionOpenSearchException
-
getComponentTemplate
public CompletableFuture<GetComponentTemplateResponse> getComponentTemplate(GetComponentTemplateRequest request) throws IOException, OpenSearchException Returns one or more component templates.- Throws:
IOExceptionOpenSearchException
-
getComponentTemplate
public final CompletableFuture<GetComponentTemplateResponse> getComponentTemplate(Function<GetComponentTemplateRequest.Builder, ObjectBuilder<GetComponentTemplateRequest>> fn) throws IOException, OpenSearchExceptionReturns one or more component templates.- Parameters:
fn- a function that initializes a builder to create theGetComponentTemplateRequest- Throws:
IOExceptionOpenSearchException
-
getComponentTemplate
public final CompletableFuture<GetComponentTemplateResponse> getComponentTemplate() throws IOException, OpenSearchExceptionReturns one or more component templates.- Throws:
IOExceptionOpenSearchException
-
getSettings
public CompletableFuture<GetClusterSettingsResponse> getSettings(GetClusterSettingsRequest request) throws IOException, OpenSearchException Returns cluster settings.- Throws:
IOExceptionOpenSearchException
-
getSettings
public final CompletableFuture<GetClusterSettingsResponse> getSettings(Function<GetClusterSettingsRequest.Builder, ObjectBuilder<GetClusterSettingsRequest>> fn) throws IOException, OpenSearchExceptionReturns cluster settings.- Parameters:
fn- a function that initializes a builder to create theGetClusterSettingsRequest- Throws:
IOExceptionOpenSearchException
-
getSettings
public final CompletableFuture<GetClusterSettingsResponse> getSettings() throws IOException, OpenSearchExceptionReturns cluster settings.- Throws:
IOExceptionOpenSearchException
-
health
public CompletableFuture<HealthResponse> health(HealthRequest request) throws IOException, OpenSearchException Returns basic information about the health of the cluster.- Throws:
IOExceptionOpenSearchException
-
health
public final CompletableFuture<HealthResponse> health(Function<HealthRequest.Builder, ObjectBuilder<HealthRequest>> fn) throws IOException, OpenSearchExceptionReturns basic information about the health of the cluster.- Parameters:
fn- a function that initializes a builder to create theHealthRequest- Throws:
IOExceptionOpenSearchException
-
health
Returns basic information about the health of the cluster.- Throws:
IOExceptionOpenSearchException
-
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:
IOExceptionOpenSearchException
-
pendingTasks
public final CompletableFuture<PendingTasksResponse> pendingTasks(Function<PendingTasksRequest.Builder, ObjectBuilder<PendingTasksRequest>> fn) throws IOException, OpenSearchExceptionReturns 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 thePendingTasksRequest- Throws:
IOExceptionOpenSearchException
-
pendingTasks
public final CompletableFuture<PendingTasksResponse> pendingTasks() throws IOException, OpenSearchExceptionReturns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.- Throws:
IOExceptionOpenSearchException
-
postVotingConfigExclusions
public CompletableFuture<BooleanResponse> postVotingConfigExclusions(PostVotingConfigExclusionsRequest request) throws IOException, OpenSearchException Updates the cluster voting configuration by excluding certain node IDs or names.- Throws:
IOExceptionOpenSearchException
-
postVotingConfigExclusions
public final CompletableFuture<BooleanResponse> postVotingConfigExclusions(Function<PostVotingConfigExclusionsRequest.Builder, ObjectBuilder<PostVotingConfigExclusionsRequest>> fn) throws IOException, OpenSearchExceptionUpdates the cluster voting configuration by excluding certain node IDs or names.- Parameters:
fn- a function that initializes a builder to create thePostVotingConfigExclusionsRequest- Throws:
IOExceptionOpenSearchException
-
postVotingConfigExclusions
public final CompletableFuture<BooleanResponse> postVotingConfigExclusions() throws IOException, OpenSearchExceptionUpdates the cluster voting configuration by excluding certain node IDs or names.- Throws:
IOExceptionOpenSearchException
-
putComponentTemplate
public CompletableFuture<PutComponentTemplateResponse> putComponentTemplate(PutComponentTemplateRequest request) throws IOException, OpenSearchException Creates or updates a component template.- Throws:
IOExceptionOpenSearchException
-
putComponentTemplate
public final CompletableFuture<PutComponentTemplateResponse> putComponentTemplate(Function<PutComponentTemplateRequest.Builder, ObjectBuilder<PutComponentTemplateRequest>> fn) throws IOException, OpenSearchExceptionCreates or updates a component template.- Parameters:
fn- a function that initializes a builder to create thePutComponentTemplateRequest- Throws:
IOExceptionOpenSearchException
-
putSettings
public CompletableFuture<PutClusterSettingsResponse> putSettings(PutClusterSettingsRequest request) throws IOException, OpenSearchException Updates the cluster settings.- Throws:
IOExceptionOpenSearchException
-
putSettings
public final CompletableFuture<PutClusterSettingsResponse> putSettings(Function<PutClusterSettingsRequest.Builder, ObjectBuilder<PutClusterSettingsRequest>> fn) throws IOException, OpenSearchExceptionUpdates the cluster settings.- Parameters:
fn- a function that initializes a builder to create thePutClusterSettingsRequest- Throws:
IOExceptionOpenSearchException
-
putSettings
public final CompletableFuture<PutClusterSettingsResponse> putSettings() throws IOException, OpenSearchExceptionUpdates the cluster settings.- Throws:
IOExceptionOpenSearchException
-
remoteInfo
public CompletableFuture<RemoteInfoResponse> remoteInfo(RemoteInfoRequest request) throws IOException, OpenSearchException Returns the information about configured remote clusters.- Throws:
IOExceptionOpenSearchException
-
remoteInfo
public final CompletableFuture<RemoteInfoResponse> remoteInfo(Function<RemoteInfoRequest.Builder, ObjectBuilder<RemoteInfoRequest>> fn) throws IOException, OpenSearchExceptionReturns the information about configured remote clusters.- Parameters:
fn- a function that initializes a builder to create theRemoteInfoRequest- Throws:
IOExceptionOpenSearchException
-
remoteInfo
public final CompletableFuture<RemoteInfoResponse> remoteInfo() throws IOException, OpenSearchExceptionReturns the information about configured remote clusters.- Throws:
IOExceptionOpenSearchException
-
reroute
public CompletableFuture<RerouteResponse> reroute(RerouteRequest request) throws IOException, OpenSearchException Allows to manually change the allocation of individual shards in the cluster.- Throws:
IOExceptionOpenSearchException
-
reroute
public final CompletableFuture<RerouteResponse> reroute(Function<RerouteRequest.Builder, ObjectBuilder<RerouteRequest>> fn) throws IOException, OpenSearchExceptionAllows to manually change the allocation of individual shards in the cluster.- Parameters:
fn- a function that initializes a builder to create theRerouteRequest- Throws:
IOExceptionOpenSearchException
-
reroute
Allows to manually change the allocation of individual shards in the cluster.- Throws:
IOExceptionOpenSearchException
-
state
public CompletableFuture<StateResponse> state(StateRequest request) throws IOException, OpenSearchException Returns comprehensive information about the state of the cluster.- Throws:
IOExceptionOpenSearchException
-
state
public final CompletableFuture<StateResponse> state(Function<StateRequest.Builder, ObjectBuilder<StateRequest>> fn) throws IOException, OpenSearchExceptionReturns comprehensive information about the state of the cluster.- Parameters:
fn- a function that initializes a builder to create theStateRequest- Throws:
IOExceptionOpenSearchException
-
state
Returns comprehensive information about the state of the cluster.- Throws:
IOExceptionOpenSearchException
-
stats
public CompletableFuture<ClusterStatsResponse> stats(ClusterStatsRequest request) throws IOException, OpenSearchException Returns a high-level overview of cluster statistics.- Throws:
IOExceptionOpenSearchException
-
stats
public final CompletableFuture<ClusterStatsResponse> stats(Function<ClusterStatsRequest.Builder, ObjectBuilder<ClusterStatsRequest>> fn) throws IOException, OpenSearchExceptionReturns a high-level overview of cluster statistics.- Parameters:
fn- a function that initializes a builder to create theClusterStatsRequest- Throws:
IOExceptionOpenSearchException
-
stats
public final CompletableFuture<ClusterStatsResponse> stats() throws IOException, OpenSearchExceptionReturns a high-level overview of cluster statistics.- Throws:
IOExceptionOpenSearchException
-