Package co.elastic.clients.elasticsearch.ml

Class DataframeAnalytics

java.lang.Object
co.elastic.clients.elasticsearch.ml.DataframeAnalytics
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class DataframeAnalytics extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static DataframeAnalytics of(Function<DataframeAnalytics.Builder,ObjectBuilder<DataframeAnalytics>> fn)

    • analysisStats

      @Nullable public final DataframeAnalyticsStats analysisStats()
      An object containing information about the analysis job.

      API name: analysis_stats

    • assignmentExplanation

      @Nullable public final String assignmentExplanation()
      For running jobs only, contains messages relating to the selection of a node to run the job.

      API name: assignment_explanation

    • dataCounts

      public final DataframeAnalyticsStatsDataCounts dataCounts()
      Required - An object that provides counts for the quantity of documents skipped, used in training, or available for testing.

      API name: data_counts

    • id

      public final String id()
      Required - The unique identifier of the data frame analytics job.

      API name: id

    • memoryUsage

      public final DataframeAnalyticsStatsMemoryUsage memoryUsage()
      Required - An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.

      API name: memory_usage

    • node

      @Nullable public final NodeAttributes node()
      Contains properties for the node that runs the job. This information is available only for running jobs.

      API name: node

    • progress

      public final List<DataframeAnalyticsStatsProgress> progress()
      Required - The progress report of the data frame analytics job by phase.

      API name: progress

    • state

      public final DataframeState state()
      Required - The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.

      API name: state

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupDataframeAnalyticsDeserializer

      protected static void setupDataframeAnalyticsDeserializer(ObjectDeserializer<DataframeAnalytics.Builder> op)