Package co.elastic.clients.elasticsearch.ml

Class UpdateModelSnapshotRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<UpdateModelSnapshotRequest.Builder>

co.elastic.clients.elasticsearch.ml.UpdateModelSnapshotRequest.Builder

All Implemented Interfaces:

WithJson<UpdateModelSnapshotRequest.Builder>, ObjectBuilder<UpdateModelSnapshotRequest>

Enclosing class:

UpdateModelSnapshotRequest

public static class UpdateModelSnapshotRequest.Builder
extends WithJsonObjectBuilderBase<UpdateModelSnapshotRequest.Builder>
implements ObjectBuilder<UpdateModelSnapshotRequest>

Builder for UpdateModelSnapshotRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpdateModelSnapshotRequest	build()	Builds a UpdateModelSnapshotRequest.
UpdateModelSnapshotRequest.Builder	description(java.lang.String value)	A description of the model snapshot.
UpdateModelSnapshotRequest.Builder	jobId(java.lang.String value)	Required - Identifier for the anomaly detection job.
UpdateModelSnapshotRequest.Builder	retain(java.lang.Boolean value)	If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days.
protected UpdateModelSnapshotRequest.Builder	self()
UpdateModelSnapshotRequest.Builder	snapshotId(java.lang.String value)	Required - Identifier for the model snapshot.

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

withJson

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

description

public final UpdateModelSnapshotRequest.Builder description(@Nullable
java.lang.String value)

A description of the model snapshot.

API name: description

jobId

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

Required - Identifier for the anomaly detection job.

API name: job_id

retain

public final UpdateModelSnapshotRequest.Builder retain(@Nullable
java.lang.Boolean value)

If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted.

API name: retain

snapshotId

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

Required - Identifier for the model snapshot.

API name: snapshot_id

self

protected UpdateModelSnapshotRequest.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<UpdateModelSnapshotRequest.Builder>

build

public UpdateModelSnapshotRequest build()

Builds a UpdateModelSnapshotRequest.

Specified by:

build in interface ObjectBuilder<UpdateModelSnapshotRequest>

Throws:

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