Package co.elastic.clients.elasticsearch.ml

Class ModelSnapshot.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.ml.ModelSnapshot.Builder

All Implemented Interfaces:

WithJson<ModelSnapshot.Builder>, ObjectBuilder<ModelSnapshot>

Enclosing class:

ModelSnapshot

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

Builder for ModelSnapshot.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ModelSnapshot	build()	Builds a ModelSnapshot.
final ModelSnapshot.Builder	description(String value)	An optional description of the job.
final ModelSnapshot.Builder	jobId(String value)	Required - A numerical character string that uniquely identifies the job that the snapshot was created for.
final ModelSnapshot.Builder	latestRecordTimeStamp(Integer value)	The timestamp of the latest processed record.
final ModelSnapshot.Builder	latestResultTimeStamp(Integer value)	The timestamp of the latest bucket result.
final ModelSnapshot.Builder	minVersion(String value)	Required - The minimum version required to be able to restore the model snapshot.
final ModelSnapshot.Builder	modelSizeStats(ModelSizeStats value)	Summary information describing the model.
final ModelSnapshot.Builder	modelSizeStats(Function<ModelSizeStats.Builder,ObjectBuilder<ModelSizeStats>> fn)	Summary information describing the model.
final ModelSnapshot.Builder	retain(boolean value)	Required - If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days.
protected ModelSnapshot.Builder	self()
final ModelSnapshot.Builder	snapshotDocCount(long value)	Required - For internal use only.
final ModelSnapshot.Builder	snapshotId(String value)	Required - A numerical character string that uniquely identifies the model snapshot.
final ModelSnapshot.Builder	timestamp(long value)	Required - The creation timestamp for the 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 ModelSnapshot.Builder description(@Nullable
 String value)

An optional description of the job.

API name: description

jobId

public final ModelSnapshot.Builder jobId(String value)

Required - A numerical character string that uniquely identifies the job that the snapshot was created for.

API name: job_id

latestRecordTimeStamp

public final ModelSnapshot.Builder latestRecordTimeStamp(@Nullable
 Integer value)

The timestamp of the latest processed record.

API name: latest_record_time_stamp

latestResultTimeStamp

public final ModelSnapshot.Builder latestResultTimeStamp(@Nullable
 Integer value)

The timestamp of the latest bucket result.

API name: latest_result_time_stamp

minVersion

public final ModelSnapshot.Builder minVersion(String value)

Required - The minimum version required to be able to restore the model snapshot.

API name: min_version

modelSizeStats

public final ModelSnapshot.Builder modelSizeStats(@Nullable
 ModelSizeStats value)

Summary information describing the model.

API name: model_size_stats

modelSizeStats

public final ModelSnapshot.Builder modelSizeStats(Function<ModelSizeStats.Builder,ObjectBuilder<ModelSizeStats>> fn)

Summary information describing the model.

API name: model_size_stats

retain

public final ModelSnapshot.Builder retain(boolean value)

Required - 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. The default value is false.

API name: retain

snapshotDocCount

public final ModelSnapshot.Builder snapshotDocCount(long value)

Required - For internal use only.

API name: snapshot_doc_count

snapshotId

public final ModelSnapshot.Builder snapshotId(String value)

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

API name: snapshot_id

timestamp

public final ModelSnapshot.Builder timestamp(long value)

Required - The creation timestamp for the snapshot.

API name: timestamp

self

protected ModelSnapshot.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ModelSnapshot.Builder>

build

public ModelSnapshot build()

Builds a ModelSnapshot.

Specified by:

build in interface ObjectBuilder<ModelSnapshot>

Throws:

NullPointerException - if some of the required fields are null.