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 Details

    • Builder

      public Builder()

  • Method Details

    • description

      public final ModelSnapshot.Builder description​(@Nullable java.lang.String value)
      An optional description of the job.

      API name: description

    • jobId

      public final ModelSnapshot.Builder jobId​(java.lang.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 java.lang.Integer value)
      The timestamp of the latest processed record.

      API name: latest_record_time_stamp

    • latestResultTimeStamp

      public final ModelSnapshot.Builder latestResultTimeStamp​(@Nullable java.lang.Integer value)
      The timestamp of the latest bucket result.

      API name: latest_result_time_stamp

    • minVersion

      public final ModelSnapshot.Builder minVersion​(java.lang.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​(java.util.function.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​(java.lang.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:
      java.lang.NullPointerException - if some of the required fields are null.