Package co.elastic.clients.elasticsearch.ml

Class SetUpgradeModeRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.SetUpgradeModeRequest

public class SetUpgradeModeRequest
extends RequestBase

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:

API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SetUpgradeModeRequest.Builder	Builder for SetUpgradeModeRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<SetUpgradeModeRequest,SetUpgradeModeResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.set_upgrade_mode".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	enabled()	When true, it enables upgrade_mode which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from starting.
static SetUpgradeModeRequest	of(java.util.function.Function<SetUpgradeModeRequest.Builder,ObjectBuilder<SetUpgradeModeRequest>> fn)
Time	timeout()	The time to wait for the request to be completed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<SetUpgradeModeRequest,SetUpgradeModeResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.set_upgrade_mode".

Method Details

of

public static SetUpgradeModeRequest of(java.util.function.Function<SetUpgradeModeRequest.Builder,ObjectBuilder<SetUpgradeModeRequest>> fn)

enabled

@Nullable
public final java.lang.Boolean enabled()

When true, it enables upgrade_mode which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from starting.

API name: enabled

timeout

@Nullable
public final Time timeout()

The time to wait for the request to be completed.

API name: timeout