Package co.elastic.clients.elasticsearch.ml

Class UpgradeJobSnapshotRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.elasticsearch.ml.UpgradeJobSnapshotRequest.Builder

All Implemented Interfaces:

ObjectBuilder<UpgradeJobSnapshotRequest>

Enclosing class:

UpgradeJobSnapshotRequest

public static class UpgradeJobSnapshotRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<UpgradeJobSnapshotRequest>

Builder for UpgradeJobSnapshotRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

jobId

public final UpgradeJobSnapshotRequest.Builder jobId(java.lang.String value)

Required - Identifier for the anomaly detection job.

API name: job_id

snapshotId

public final UpgradeJobSnapshotRequest.Builder snapshotId(java.lang.String value)

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

API name: snapshot_id

timeout

public final UpgradeJobSnapshotRequest.Builder timeout(@Nullable
Time value)

Controls the time to wait for the request to complete.

API name: timeout

timeout

public final UpgradeJobSnapshotRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Controls the time to wait for the request to complete.

API name: timeout

waitForCompletion

public final UpgradeJobSnapshotRequest.Builder waitForCompletion(@Nullable
java.lang.Boolean value)

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

build

public UpgradeJobSnapshotRequest build()

Builds a UpgradeJobSnapshotRequest.

Specified by:

build in interface ObjectBuilder<UpgradeJobSnapshotRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.