Class SetUpgradeModeRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.SetUpgradeModeRequest
Sets a cluster wide upgrade_mode setting that prepares machine learning
indices for an upgrade. When upgrading your cluster, in some circumstances
you must restart your nodes and reindex your machine learning indices. In
those circumstances, there must be no machine learning jobs running. You can
close the machine learning jobs, do the upgrade, then open all the jobs
again. Alternatively, you can use this API to temporarily halt tasks
associated with the jobs and datafeeds and prevent new jobs from opening. You
can also use this API during upgrades that do not require you to reindex your
machine learning indices, though stopping jobs is not a requirement in that
case. You can see the current value for the upgrade_mode setting by using the
get machine learning info API.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<SetUpgradeModeRequest,
SetUpgradeModeResponse, ErrorResponse> Endpoint "ml.set_upgrade_mode
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
enabled()
Whentrue
, it enablesupgrade_mode
which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from starting.static SetUpgradeModeRequest
final Time
timeout()
The time to wait for the request to be completed.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "ml.set_upgrade_mode
".
-
-
Method Details
-
of
public static SetUpgradeModeRequest of(Function<SetUpgradeModeRequest.Builder, ObjectBuilder<SetUpgradeModeRequest>> fn) -
enabled
Whentrue
, it enablesupgrade_mode
which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from starting.API name:
enabled
-
timeout
The time to wait for the request to be completed.API name:
timeout
-