Package co.elastic.clients.elasticsearch.ml

Class DataDescription.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<DataDescription.Builder>
co.elastic.clients.elasticsearch.ml.DataDescription.Builder
All Implemented Interfaces:
WithJson<DataDescription.Builder>, ObjectBuilder<DataDescription>
Enclosing class:
DataDescription
public static class DataDescription.Builder extends WithJsonObjectBuilderBase<DataDescription.Builder> implements ObjectBuilder<DataDescription>
Builder for DataDescription.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • format

      public final DataDescription.Builder format(@Nullable String value)
      Only JSON format is supported at this time.

      API name: format

    • timeField

      public final DataDescription.Builder timeField(String value)
      Required - The name of the field that contains the timestamp.

      API name: time_field

    • timeFormat

      public final DataDescription.Builder timeFormat(@Nullable String value)
      The time format, which can be epoch, epoch_ms, or a custom pattern. The value epoch refers to UNIX or Epoch time (the number of seconds since 1 Jan 1970). The value epoch_ms indicates that time is measured in milliseconds since the epoch. The epoch and epoch_ms time formats accept either integer or real values. Custom patterns must conform to the Java DateTimeFormatter class. When you use date-time formatting patterns, it is recommended that you provide the full date, time and time zone. For example: yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not sufficient to produce a complete timestamp, job creation fails.

      API name: time_format

    • fieldDelimiter

      public final DataDescription.Builder fieldDelimiter(@Nullable String value)
      API name: field_delimiter

    • self

      protected DataDescription.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<DataDescription.Builder>

    • build

      public DataDescription build()
      Builds a DataDescription.
      Specified by:
      build in interface ObjectBuilder<DataDescription>
      Throws:
      NullPointerException - if some of the required fields are null.