Package co.elastic.clients.elasticsearch.ml

Class UpgradeJobSnapshotRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.UpgradeJobSnapshotRequest

public class UpgradeJobSnapshotRequest
extends RequestBase

Upgrades an anomaly detection model snapshot to the latest major version. Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version. This API provides a means to upgrade a snapshot to the current major version. This aids in preparing the cluster for an upgrade to the next major version. Only one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 final Endpoint<UpgradeJobSnapshotRequest,UpgradeJobSnapshotResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.upgrade_job_snapshot".

Method Summary

Modifier and Type	Method	Description
final String	jobId()	Required - Identifier for the anomaly detection job.
static UpgradeJobSnapshotRequest	of(Function<UpgradeJobSnapshotRequest.Builder,ObjectBuilder<UpgradeJobSnapshotRequest>> fn)
final String	snapshotId()	Required - A numerical character string that uniquely identifies the model snapshot.
final Time	timeout()	Controls the time to wait for the request to complete.
final Boolean	waitForCompletion()	When true, the API won’t respond until the upgrade is complete.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<UpgradeJobSnapshotRequest,UpgradeJobSnapshotResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.upgrade_job_snapshot".

Method Details

of

public static UpgradeJobSnapshotRequest of(Function<UpgradeJobSnapshotRequest.Builder,ObjectBuilder<UpgradeJobSnapshotRequest>> fn)

jobId

public final String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

snapshotId

public final String snapshotId()

Required - A numerical character string that uniquely identifies the model snapshot.

API name: snapshot_id

timeout

@Nullable
public final Time timeout()

Controls the time to wait for the request to complete.

API name: timeout

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

When true, the API won’t respond until the upgrade is complete. Otherwise, it responds as soon as the upgrade task is assigned to a node.

API name: wait_for_completion