Package co.elastic.clients.elasticsearch.ml

Class GetRecordsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetRecordsRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class GetRecordsRequest
extends RequestBase
implements JsonpSerializable
Retrieves anomaly records for an anomaly detection job. Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data. In practice, there are often too many to be able to manually process them. The machine learning features therefore perform a sophisticated aggregation of the anomaly records into buckets. The number of record results depends on the number of anomalies found in each bucket, which relates to the number of time series being modeled and the number of detectors.
See Also:
API specification

  • Field Details

  • Method Details

    • of

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

    • desc

      @Nullable public final java.lang.Boolean desc()
      Refer to the description for the desc query parameter.

      API name: desc

    • end

      @Nullable public final java.lang.String end()
      Refer to the description for the end query parameter.

      API name: end

    • excludeInterim

      @Nullable public final java.lang.Boolean excludeInterim()
      Refer to the description for the exclude_interim query parameter.

      API name: exclude_interim

    • from

      @Nullable public final java.lang.Integer from()
      Skips the specified number of records.

      API name: from

    • jobId

      public final java.lang.String jobId()
      Required - Identifier for the anomaly detection job.

      API name: job_id

    • page

      @Nullable public final Page page()
      API name: page

    • recordScore

      @Nullable public final java.lang.Double recordScore()
      Refer to the description for the record_score query parameter.

      API name: record_score

    • size

      @Nullable public final java.lang.Integer size()
      Specifies the maximum number of records to obtain.

      API name: size

    • sort

      @Nullable public final java.lang.String sort()
      Refer to the description for the sort query parameter.

      API name: sort

    • start

      @Nullable public final java.lang.String start()
      Refer to the description for the start query parameter.

      API name: 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)

    • setupGetRecordsRequestDeserializer

      protected static void setupGetRecordsRequestDeserializer​(ObjectDeserializer<GetRecordsRequest.Builder> op)