Package co.elastic.clients.elasticsearch.ml

Class UpdateDataFrameAnalyticsRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowLazyStart

      public final UpdateDataFrameAnalyticsRequest.Builder allowLazyStart​(@Nullable java.lang.Boolean value)
      Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node.

      API name: allow_lazy_start

    • description

      public final UpdateDataFrameAnalyticsRequest.Builder description​(@Nullable java.lang.String value)
      A description of the job.

      API name: description

    • id

      public final UpdateDataFrameAnalyticsRequest.Builder id​(java.lang.String value)
      Required - Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.

      API name: id

    • maxNumThreads

      public final UpdateDataFrameAnalyticsRequest.Builder maxNumThreads​(@Nullable java.lang.Integer value)
      The maximum number of threads to be used by the analysis. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself.

      API name: max_num_threads

    • modelMemoryLimit

      public final UpdateDataFrameAnalyticsRequest.Builder modelMemoryLimit​(@Nullable java.lang.String value)
      The approximate maximum amount of memory resources that are permitted for analytical processing. The default value for data frame analytics jobs is 1gb. If your elasticsearch.yml file contains an xpack.ml.max_model_memory_limit setting, an error occurs when you try to create data frame analytics jobs that have model_memory_limit values greater than that setting.

      API name: model_memory_limit

    • self

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

    • build

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