Package co.elastic.clients.elasticsearch.ml

Class UpdateDataFrameAnalyticsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.UpdateDataFrameAnalyticsRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class UpdateDataFrameAnalyticsRequest
extends RequestBase
implements JsonpSerializable
Updates an existing data frame analytics job.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static UpdateDataFrameAnalyticsRequest of​(java.util.function.Function<UpdateDataFrameAnalyticsRequest.Builder,​ObjectBuilder<UpdateDataFrameAnalyticsRequest>> fn)

    • allowLazyStart

      @Nullable public final java.lang.Boolean allowLazyStart()
      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

      @Nullable public final java.lang.String description()
      A description of the job.

      API name: description

    • id

      public final java.lang.String id()
      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

      @Nullable public final java.lang.Integer maxNumThreads()
      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

      @Nullable public final java.lang.String modelMemoryLimit()
      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

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupUpdateDataFrameAnalyticsRequestDeserializer

      protected static void setupUpdateDataFrameAnalyticsRequestDeserializer​(ObjectDeserializer<UpdateDataFrameAnalyticsRequest.Builder> op)