Class ClusterClient
java.lang.Object
org.opensearch.client.base.ApiClient<ClusterClient>
org.opensearch.client.opensearch.api.cluster.ClusterClient
public class ClusterClient extends ApiClient<ClusterClient>
Client for the cluster namespace.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description ClusterClient(Transport transport)ClusterClient(Transport transport, org.opensearch.client.RequestOptions options) -
Method Summary
Modifier and Type Method Description AllocationExplainResponseallocationExplain(java.util.function.Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn)Provides explanations for shard allocations in the cluster.AllocationExplainResponseallocationExplain(AllocationExplainRequest request)Provides explanations for shard allocations in the cluster.DeleteComponentTemplateResponsedeleteComponentTemplate(java.util.function.Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn)Deletes a component templateDeleteComponentTemplateResponsedeleteComponentTemplate(DeleteComponentTemplateRequest request)Deletes a component templateDeleteVotingConfigExclusionsResponsedeleteVotingConfigExclusions(java.util.function.Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn)Clears cluster voting config exclusions.DeleteVotingConfigExclusionsResponsedeleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)Clears cluster voting config exclusions.ExistsComponentTemplateResponseexistsComponentTemplate(java.util.function.Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn)Returns information about whether a particular component template existExistsComponentTemplateResponseexistsComponentTemplate(ExistsComponentTemplateRequest request)Returns information about whether a particular component template existGetComponentTemplateResponsegetComponentTemplate(java.util.function.Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)Returns one or more component templatesGetComponentTemplateResponsegetComponentTemplate(GetComponentTemplateRequest request)Returns one or more component templatesGetSettingsResponsegetSettings(java.util.function.Function<GetSettingsRequest.Builder,ObjectBuilder<GetSettingsRequest>> fn)Returns cluster settings.GetSettingsResponsegetSettings(GetSettingsRequest request)Returns cluster settings.HealthResponsehealth(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn)Returns basic information about the health of the cluster.HealthResponsehealth(HealthRequest request)Returns basic information about the health of the cluster.PendingTasksResponsependingTasks(java.util.function.Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn)Returns a list of any cluster-level changes (e.g.PendingTasksResponsependingTasks(PendingTasksRequest request)Returns a list of any cluster-level changes (e.g.PutVotingConfigExclusionsResponsepostVotingConfigExclusions(java.util.function.Function<PutVotingConfigExclusionsRequest.Builder,ObjectBuilder<PutVotingConfigExclusionsRequest>> fn)Updates the cluster voting config exclusions by node ids or node names.PutVotingConfigExclusionsResponsepostVotingConfigExclusions(PutVotingConfigExclusionsRequest request)Updates the cluster voting config exclusions by node ids or node names.PutComponentTemplateResponseputComponentTemplate(java.util.function.Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)Creates or updates a component templatePutComponentTemplateResponseputComponentTemplate(PutComponentTemplateRequest request)Creates or updates a component templatePutSettingsResponseputSettings(java.util.function.Function<PutSettingsRequest.Builder,ObjectBuilder<PutSettingsRequest>> fn)Updates the cluster settings.PutSettingsResponseputSettings(PutSettingsRequest request)Updates the cluster settings.RemoteInfoResponseremoteInfo(java.util.function.Function<RemoteInfoRequest.Builder,ObjectBuilder<RemoteInfoRequest>> fn)Returns the information about configured remote clusters.RemoteInfoResponseremoteInfo(RemoteInfoRequest request)Returns the information about configured remote clusters.RerouteResponsereroute(java.util.function.Function<RerouteRequest.Builder,ObjectBuilder<RerouteRequest>> fn)Allows to manually change the allocation of individual shards in the cluster.RerouteResponsereroute(RerouteRequest request)Allows to manually change the allocation of individual shards in the cluster.StateResponsestate(java.util.function.Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn)Returns a comprehensive information about the state of the cluster.StateResponsestate(StateRequest request)Returns a comprehensive information about the state of the cluster.StatsResponsestats(java.util.function.Function<StatsRequest.Builder,ObjectBuilder<StatsRequest>> fn)Returns high-level overview of cluster statistics.StatsResponsestats(StatsRequest request)Returns high-level overview of cluster statistics.ClusterClientwithRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)Creates a newClusterClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions)with specific request options, inheriting existing options.ClusterClientwithRequestOptions(org.opensearch.client.RequestOptions options)Creates a newClusterClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions)with specific request options.
-
Constructor Details
-
Method Details
-
allocationExplain
public AllocationExplainResponse allocationExplain(AllocationExplainRequest request) throws java.io.IOExceptionProvides explanations for shard allocations in the cluster.- Throws:
java.io.IOException
-
allocationExplain
public final AllocationExplainResponse allocationExplain(java.util.function.Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn) throws java.io.IOExceptionProvides explanations for shard allocations in the cluster.- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
deleteComponentTemplate
public DeleteComponentTemplateResponse deleteComponentTemplate(DeleteComponentTemplateRequest request) throws java.io.IOExceptionDeletes a component template- Throws:
java.io.IOException
-
deleteComponentTemplate
public final DeleteComponentTemplateResponse deleteComponentTemplate(java.util.function.Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn) throws java.io.IOExceptionDeletes a component template- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
deleteVotingConfigExclusions
public DeleteVotingConfigExclusionsResponse deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request) throws java.io.IOExceptionClears cluster voting config exclusions.- Throws:
java.io.IOException
-
deleteVotingConfigExclusions
public final DeleteVotingConfigExclusionsResponse deleteVotingConfigExclusions(java.util.function.Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn) throws java.io.IOExceptionClears cluster voting config exclusions.- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
existsComponentTemplate
public ExistsComponentTemplateResponse existsComponentTemplate(ExistsComponentTemplateRequest request) throws java.io.IOExceptionReturns information about whether a particular component template exist- Throws:
java.io.IOException
-
existsComponentTemplate
public final ExistsComponentTemplateResponse existsComponentTemplate(java.util.function.Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn) throws java.io.IOExceptionReturns information about whether a particular component template exist- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
getComponentTemplate
public GetComponentTemplateResponse getComponentTemplate(GetComponentTemplateRequest request) throws java.io.IOExceptionReturns one or more component templates- Throws:
java.io.IOException
-
getComponentTemplate
public final GetComponentTemplateResponse getComponentTemplate(java.util.function.Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn) throws java.io.IOExceptionReturns one or more component templates- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
getSettings
Returns cluster settings.- Throws:
java.io.IOException
-
getSettings
public final GetSettingsResponse getSettings(java.util.function.Function<GetSettingsRequest.Builder,ObjectBuilder<GetSettingsRequest>> fn) throws java.io.IOExceptionReturns cluster settings.- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
health
Returns basic information about the health of the cluster.- Throws:
java.io.IOException
-
health
public final HealthResponse health(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn) throws java.io.IOExceptionReturns basic information about the health of the cluster.- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
pendingTasks
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
-
pendingTasks
public final PendingTasksResponse pendingTasks(java.util.function.Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn) throws java.io.IOExceptionReturns 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 freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
postVotingConfigExclusions
public PutVotingConfigExclusionsResponse postVotingConfigExclusions(PutVotingConfigExclusionsRequest request) throws java.io.IOExceptionUpdates the cluster voting config exclusions by node ids or node names.- Throws:
java.io.IOException
-
postVotingConfigExclusions
public final PutVotingConfigExclusionsResponse postVotingConfigExclusions(java.util.function.Function<PutVotingConfigExclusionsRequest.Builder,ObjectBuilder<PutVotingConfigExclusionsRequest>> fn) throws java.io.IOExceptionUpdates the cluster voting config exclusions by node ids or node names.- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
putComponentTemplate
public PutComponentTemplateResponse putComponentTemplate(PutComponentTemplateRequest request) throws java.io.IOExceptionCreates or updates a component template- Throws:
java.io.IOException
-
putComponentTemplate
public final PutComponentTemplateResponse putComponentTemplate(java.util.function.Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn) throws java.io.IOExceptionCreates or updates a component template- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
putSettings
Updates the cluster settings.- Throws:
java.io.IOException
-
putSettings
public final PutSettingsResponse putSettings(java.util.function.Function<PutSettingsRequest.Builder,ObjectBuilder<PutSettingsRequest>> fn) throws java.io.IOExceptionUpdates the cluster settings.- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
remoteInfo
Returns the information about configured remote clusters.- Throws:
java.io.IOException
-
remoteInfo
public final RemoteInfoResponse remoteInfo(java.util.function.Function<RemoteInfoRequest.Builder,ObjectBuilder<RemoteInfoRequest>> fn) throws java.io.IOExceptionReturns the information about configured remote clusters.- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
reroute
Allows to manually change the allocation of individual shards in the cluster.- Throws:
java.io.IOException
-
reroute
public final RerouteResponse reroute(java.util.function.Function<RerouteRequest.Builder,ObjectBuilder<RerouteRequest>> fn) throws java.io.IOExceptionAllows to manually change the allocation of individual shards in the cluster.- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
state
Returns a comprehensive information about the state of the cluster.- Throws:
java.io.IOException
-
state
public final StateResponse state(java.util.function.Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn) throws java.io.IOExceptionReturns a comprehensive information about the state of the cluster.- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
stats
Returns high-level overview of cluster statistics.- Throws:
java.io.IOException
-
stats
public final StatsResponse stats(java.util.function.Function<StatsRequest.Builder,ObjectBuilder<StatsRequest>> fn) throws java.io.IOExceptionReturns high-level overview of cluster statistics.- Parameters:
fn- a function that initializes a freshly created builder. This function can either return its builder argument after having set its properties or return another builder.- Throws:
java.io.IOException
-
withRequestOptions
Creates a newClusterClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions)with specific request options.- Specified by:
withRequestOptionsin classApiClient<ClusterClient>
-
withRequestOptions
public ClusterClient withRequestOptions(java.util.function.Function<org.opensearch.client.RequestOptions.Builder,org.opensearch.client.RequestOptions.Builder> fn)Creates a newClusterClient(org.opensearch.client.base.Transport, org.opensearch.client.RequestOptions)with specific request options, inheriting existing options.- Parameters:
fn- a function taking an options builder initialized with the current request options, or initialized with default values.
-