Class ElasticsearchClusterClient
java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchClusterClient>
co.elastic.clients.elasticsearch.cluster.ElasticsearchClusterClient
public class ElasticsearchClusterClient extends ApiClient<ElasticsearchTransport,ElasticsearchClusterClient>
Client for the cluster namespace.
-
Field Summary
Fields inherited from class co.elastic.clients.ApiClient
transport, transportOptions
-
Constructor Summary
Constructors Constructor Description ElasticsearchClusterClient(ElasticsearchTransport transport)
ElasticsearchClusterClient(ElasticsearchTransport transport, TransportOptions transportOptions)
-
Method Summary
Modifier and Type Method Description AllocationExplainResponse
allocationExplain()
Provides explanations for shard allocations in the cluster.AllocationExplainResponse
allocationExplain(AllocationExplainRequest request)
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.DeleteComponentTemplateResponse
deleteComponentTemplate(DeleteComponentTemplateRequest request)
Deletes a component templateDeleteComponentTemplateResponse
deleteComponentTemplate(java.util.function.Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn)
Deletes a component templateBooleanResponse
deleteVotingConfigExclusions()
Clears cluster voting config exclusions.BooleanResponse
deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request)
Clears cluster voting config exclusions.BooleanResponse
deleteVotingConfigExclusions(java.util.function.Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn)
Clears cluster voting config exclusions.BooleanResponse
existsComponentTemplate(ExistsComponentTemplateRequest request)
Returns information about whether a particular component template existBooleanResponse
existsComponentTemplate(java.util.function.Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn)
Returns information about whether a particular component template existGetComponentTemplateResponse
getComponentTemplate()
Returns one or more component templatesGetComponentTemplateResponse
getComponentTemplate(GetComponentTemplateRequest request)
Returns one or more component templatesGetComponentTemplateResponse
getComponentTemplate(java.util.function.Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)
Returns one or more component templatesGetClusterSettingsResponse
getSettings()
Returns cluster settings.GetClusterSettingsResponse
getSettings(GetClusterSettingsRequest request)
Returns cluster settings.GetClusterSettingsResponse
getSettings(java.util.function.Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn)
Returns cluster settings.HealthResponse
health()
Returns basic information about the health of the cluster.HealthResponse
health(HealthRequest request)
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.PendingTasksResponse
pendingTasks()
Returns a list of any cluster-level changes (e.g.PendingTasksResponse
pendingTasks(PendingTasksRequest request)
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.BooleanResponse
postVotingConfigExclusions()
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.BooleanResponse
postVotingConfigExclusions(java.util.function.Function<PostVotingConfigExclusionsRequest.Builder,ObjectBuilder<PostVotingConfigExclusionsRequest>> fn)
Updates the cluster voting config exclusions by node ids or node names.PutComponentTemplateResponse
putComponentTemplate(PutComponentTemplateRequest request)
Creates or updates a component templatePutComponentTemplateResponse
putComponentTemplate(java.util.function.Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn)
Creates or updates a component templatePutClusterSettingsResponse
putSettings()
Updates the cluster settings.PutClusterSettingsResponse
putSettings(PutClusterSettingsRequest request)
Updates the cluster settings.PutClusterSettingsResponse
putSettings(java.util.function.Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn)
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(RerouteRequest request)
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.StateResponse
state()
Returns a comprehensive information about the state of the cluster.StateResponse
state(StateRequest request)
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.ClusterStatsResponse
stats()
Returns high-level overview of cluster statistics.ClusterStatsResponse
stats(ClusterStatsRequest request)
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.ElasticsearchClusterClient
withTransportOptions(TransportOptions transportOptions)
Creates a new client with some request optionsMethods inherited from class co.elastic.clients.ApiClient
_jsonpMapper, _transport, _transportOptions, getDeserializer
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
ElasticsearchClusterClient
-
ElasticsearchClusterClient
public ElasticsearchClusterClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
public ElasticsearchClusterClient withTransportOptions(@Nullable TransportOptions transportOptions)Description copied from class:ApiClient
Creates a new client with some request options- Specified by:
withTransportOptions
in classApiClient<ElasticsearchTransport,ElasticsearchClusterClient>
-
allocationExplain
public AllocationExplainResponse allocationExplain(AllocationExplainRequest request) throws java.io.IOException, ElasticsearchExceptionProvides explanations for shard allocations in the cluster.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
allocationExplain
public final AllocationExplainResponse allocationExplain(java.util.function.Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn) throws java.io.IOException, ElasticsearchExceptionProvides explanations for shard allocations in the cluster.- Parameters:
fn
- a function that initializes a builder to create theAllocationExplainRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
allocationExplain
public AllocationExplainResponse allocationExplain() throws java.io.IOException, ElasticsearchExceptionProvides explanations for shard allocations in the cluster.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
deleteComponentTemplate
public DeleteComponentTemplateResponse deleteComponentTemplate(DeleteComponentTemplateRequest request) throws java.io.IOException, ElasticsearchExceptionDeletes a component template- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
deleteComponentTemplate
public final DeleteComponentTemplateResponse deleteComponentTemplate(java.util.function.Function<DeleteComponentTemplateRequest.Builder,ObjectBuilder<DeleteComponentTemplateRequest>> fn) throws java.io.IOException, ElasticsearchExceptionDeletes a component template- Parameters:
fn
- a function that initializes a builder to create theDeleteComponentTemplateRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
deleteVotingConfigExclusions
public BooleanResponse deleteVotingConfigExclusions(DeleteVotingConfigExclusionsRequest request) throws java.io.IOException, ElasticsearchExceptionClears cluster voting config exclusions.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
deleteVotingConfigExclusions
public final BooleanResponse deleteVotingConfigExclusions(java.util.function.Function<DeleteVotingConfigExclusionsRequest.Builder,ObjectBuilder<DeleteVotingConfigExclusionsRequest>> fn) throws java.io.IOException, ElasticsearchExceptionClears cluster voting config exclusions.- Parameters:
fn
- a function that initializes a builder to create theDeleteVotingConfigExclusionsRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
deleteVotingConfigExclusions
public BooleanResponse deleteVotingConfigExclusions() throws java.io.IOException, ElasticsearchExceptionClears cluster voting config exclusions.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
existsComponentTemplate
public BooleanResponse existsComponentTemplate(ExistsComponentTemplateRequest request) throws java.io.IOException, ElasticsearchExceptionReturns information about whether a particular component template exist- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
existsComponentTemplate
public final BooleanResponse existsComponentTemplate(java.util.function.Function<ExistsComponentTemplateRequest.Builder,ObjectBuilder<ExistsComponentTemplateRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns information about whether a particular component template exist- Parameters:
fn
- a function that initializes a builder to create theExistsComponentTemplateRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getComponentTemplate
public GetComponentTemplateResponse getComponentTemplate(GetComponentTemplateRequest request) throws java.io.IOException, ElasticsearchExceptionReturns one or more component templates- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getComponentTemplate
public final GetComponentTemplateResponse getComponentTemplate(java.util.function.Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns one or more component templates- Parameters:
fn
- a function that initializes a builder to create theGetComponentTemplateRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getComponentTemplate
public GetComponentTemplateResponse getComponentTemplate() throws java.io.IOException, ElasticsearchExceptionReturns one or more component templates- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getSettings
public GetClusterSettingsResponse getSettings(GetClusterSettingsRequest request) throws java.io.IOException, ElasticsearchExceptionReturns cluster settings.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getSettings
public final GetClusterSettingsResponse getSettings(java.util.function.Function<GetClusterSettingsRequest.Builder,ObjectBuilder<GetClusterSettingsRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns cluster settings.- Parameters:
fn
- a function that initializes a builder to create theGetClusterSettingsRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
getSettings
Returns cluster settings.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
health
public HealthResponse health(HealthRequest request) throws java.io.IOException, ElasticsearchExceptionReturns basic information about the health of the cluster.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
health
public final HealthResponse health(java.util.function.Function<HealthRequest.Builder,ObjectBuilder<HealthRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns basic information about the health of the cluster.- Parameters:
fn
- a function that initializes a builder to create theHealthRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
health
Returns basic information about the health of the cluster.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
pendingTasks
public PendingTasksResponse pendingTasks(PendingTasksRequest request) throws java.io.IOException, ElasticsearchExceptionReturns 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
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
pendingTasks
public final PendingTasksResponse pendingTasks(java.util.function.Function<PendingTasksRequest.Builder,ObjectBuilder<PendingTasksRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns 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 thePendingTasksRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
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
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
postVotingConfigExclusions
public BooleanResponse postVotingConfigExclusions(PostVotingConfigExclusionsRequest request) throws java.io.IOException, ElasticsearchExceptionUpdates the cluster voting config exclusions by node ids or node names.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
postVotingConfigExclusions
public final BooleanResponse postVotingConfigExclusions(java.util.function.Function<PostVotingConfigExclusionsRequest.Builder,ObjectBuilder<PostVotingConfigExclusionsRequest>> fn) throws java.io.IOException, ElasticsearchExceptionUpdates the cluster voting config exclusions by node ids or node names.- Parameters:
fn
- a function that initializes a builder to create thePostVotingConfigExclusionsRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
postVotingConfigExclusions
public BooleanResponse postVotingConfigExclusions() throws java.io.IOException, ElasticsearchExceptionUpdates the cluster voting config exclusions by node ids or node names.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
putComponentTemplate
public PutComponentTemplateResponse putComponentTemplate(PutComponentTemplateRequest request) throws java.io.IOException, ElasticsearchExceptionCreates or updates a component template- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
putComponentTemplate
public final PutComponentTemplateResponse putComponentTemplate(java.util.function.Function<PutComponentTemplateRequest.Builder,ObjectBuilder<PutComponentTemplateRequest>> fn) throws java.io.IOException, ElasticsearchExceptionCreates or updates a component template- Parameters:
fn
- a function that initializes a builder to create thePutComponentTemplateRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
putSettings
public PutClusterSettingsResponse putSettings(PutClusterSettingsRequest request) throws java.io.IOException, ElasticsearchExceptionUpdates the cluster settings.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
putSettings
public final PutClusterSettingsResponse putSettings(java.util.function.Function<PutClusterSettingsRequest.Builder,ObjectBuilder<PutClusterSettingsRequest>> fn) throws java.io.IOException, ElasticsearchExceptionUpdates the cluster settings.- Parameters:
fn
- a function that initializes a builder to create thePutClusterSettingsRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
putSettings
Updates the cluster settings.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
remoteInfo
Returns the information about configured remote clusters.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
reroute
public RerouteResponse reroute(RerouteRequest request) throws java.io.IOException, ElasticsearchExceptionAllows to manually change the allocation of individual shards in the cluster.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
reroute
public final RerouteResponse reroute(java.util.function.Function<RerouteRequest.Builder,ObjectBuilder<RerouteRequest>> fn) throws java.io.IOException, ElasticsearchExceptionAllows to manually change the allocation of individual shards in the cluster.- Parameters:
fn
- a function that initializes a builder to create theRerouteRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
reroute
Allows to manually change the allocation of individual shards in the cluster.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
state
public StateResponse state(StateRequest request) throws java.io.IOException, ElasticsearchExceptionReturns a comprehensive information about the state of the cluster.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
state
public final StateResponse state(java.util.function.Function<StateRequest.Builder,ObjectBuilder<StateRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns a comprehensive information about the state of the cluster.- Parameters:
fn
- a function that initializes a builder to create theStateRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
state
Returns a comprehensive information about the state of the cluster.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
stats
public ClusterStatsResponse stats(ClusterStatsRequest request) throws java.io.IOException, ElasticsearchExceptionReturns high-level overview of cluster statistics.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
stats
public final ClusterStatsResponse stats(java.util.function.Function<ClusterStatsRequest.Builder,ObjectBuilder<ClusterStatsRequest>> fn) throws java.io.IOException, ElasticsearchExceptionReturns high-level overview of cluster statistics.- Parameters:
fn
- a function that initializes a builder to create theClusterStatsRequest
- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-
stats
Returns high-level overview of cluster statistics.- Throws:
java.io.IOException
ElasticsearchException
- See Also:
- Documentation on elastic.co
-