Class UpgradeJobSnapshotRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.UpgradeJobSnapshotRequest
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:
-
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 TypeFieldDescriptionEndpoint "ml.upgrade_job_snapshot
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
jobId()
Required - Identifier for the anomaly detection job.static UpgradeJobSnapshotRequest
final String
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
When true, the API won’t respond until the upgrade is complete.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
public static final Endpoint<UpgradeJobSnapshotRequest,UpgradeJobSnapshotResponse, _ENDPOINTErrorResponse> Endpoint "ml.upgrade_job_snapshot
".
-
-
Method Details
-
of
public static UpgradeJobSnapshotRequest of(Function<UpgradeJobSnapshotRequest.Builder, ObjectBuilder<UpgradeJobSnapshotRequest>> fn) -
jobId
Required - Identifier for the anomaly detection job.API name:
job_id
-
snapshotId
Required - A numerical character string that uniquely identifies the model snapshot.API name:
snapshot_id
-
timeout
Controls the time to wait for the request to complete.API name:
timeout
-
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
-