Class ExplainDataFrameAnalyticsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.ExplainDataFrameAnalyticsRequest
All Implemented Interfaces:
JsonpSerializable

@JsonpDeserializable
public class ExplainDataFrameAnalyticsRequest
extends RequestBase
implements JsonpSerializable
Explains a data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided:
  • which fields are included or not in the analysis and why,
  • how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.
See Also:
API specification
  • Field Details

  • Method Details

    • of

    • 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

    • analysis

      @Nullable public final DataframeAnalysis analysis()
      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

    • analyzedFields

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

    • description

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

      API name: description

    • dest

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

      API name: dest

    • id

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

    • maxNumThreads

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

    • 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

    • source

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

    • 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​(ObjectDeserializer<ExplainDataFrameAnalyticsRequest.Builder> op)