UpgradeJobSnapshotRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.UpgradeJobSnapshotRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class UpgradeJobSnapshotRequest
extends RequestBase

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 Endpoint<UpgradeJobSnapshotRequest,UpgradeJobSnapshotResponse,ElasticsearchError> ENDPOINT
Endpoint "ml.upgrade_job_snapshot".

Constructor Summary

Constructors
Constructor	Description
`UpgradeJobSnapshotRequest(UpgradeJobSnapshotRequest.Builder builder)`
`UpgradeJobSnapshotRequest(java.util.function.Function<UpgradeJobSnapshotRequest.Builder,UpgradeJobSnapshotRequest.Builder> fn)`

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`jobId()`	Required - Identifier for the anomaly detection job.
`java.lang.String`	`snapshotId()`	Required - A numerical character string that uniquely identifies the model snapshot.
`java.lang.String`	`timeout()`	Controls the time to wait for the request to complete.
`java.lang.Boolean`	`waitForCompletion()`	When true, the API won’t respond until the upgrade is complete.

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<UpgradeJobSnapshotRequest,UpgradeJobSnapshotResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "ml.upgrade_job_snapshot".
Constructor Details
- UpgradeJobSnapshotRequest
  
  public UpgradeJobSnapshotRequest(UpgradeJobSnapshotRequest.Builder builder)
- UpgradeJobSnapshotRequest
  
  public UpgradeJobSnapshotRequest(java.util.function.Function<UpgradeJobSnapshotRequest.Builder,UpgradeJobSnapshotRequest.Builder> fn)
Method Details
- jobId
  
  public java.lang.String jobId()
  
  Required - Identifier for the anomaly detection job.
  API name: job_id
- snapshotId
  
  public java.lang.String snapshotId()
  
  Required - A numerical character string that uniquely identifies the model snapshot.
  API name: snapshot_id
- waitForCompletion
  
  @Nullable public java.lang.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
- timeout
  
  @Nullable public java.lang.String timeout()
  
  Controls the time to wait for the request to complete.
  API name: timeout