Package co.elastic.clients.elasticsearch.ml

Class ExplainDataFrameAnalyticsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.ExplainDataFrameAnalyticsRequest
All Implemented Interfaces:
ElasticsearchCommonRequest, JsonpSerializable
@JsonpDeserializable
public final class ExplainDataFrameAnalyticsRequest
extends RequestBase
implements JsonpSerializable

  • Field Details

  • Constructor Details

  • Method Details

    • id

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

    • source

      @Nullable public DataframeAnalyticsSource source()
      The configuration of how to source the analysis data. It requires an index. Optionally, query and _source may be specified.

      API name: source

    • dest

      @Nullable public DataframeAnalyticsDestination dest()
      The destination configuration, consisting of index and optionally results_field (ml by default).

      API name: dest

    • analysis

      public DataframeAnalysis analysis()
      Required - The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression.

      API name: analysis

    • description

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

      API name: description

    • modelMemoryLimit

      @Nullable public 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

    • maxNumThreads

      @Nullable public java.lang.Integer maxNumThreads()
      The maximum number of threads to be used by the analysis. The default value is 1. 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

    • analyzedFields

      @Nullable public jakarta.json.JsonValue analyzedFields()
      Specify includes and/or excludes patterns to select which fields will be included in the analysis. The patterns specified in excludes are applied last, therefore excludes takes precedence. In other words, if the same field is specified in both includes and excludes, then the field will not be included in the analysis.

      API name: analyzed_fields

    • allowLazyStart

      @Nullable public 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

    • 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)

    • setupExplainDataFrameAnalyticsRequestDeserializer

      protected static void setupExplainDataFrameAnalyticsRequestDeserializer​(DelegatingDeserializer<ExplainDataFrameAnalyticsRequest.Builder> op)