Package co.elastic.clients.elasticsearch.ml

Class BucketSummary

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

  • Field Details

  • Method Details

    • of

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

    • anomalyScore

      public final double anomalyScore()
      Required - The maximum anomaly score, between 0-100, for any of the bucket influencers. This is an overall, rate-limited score for the job. All the anomaly records in the bucket contribute to this score. This value might be updated as new data is analyzed.

      API name: anomaly_score

    • bucketInfluencers

      public final java.util.List<BucketInfluencer> bucketInfluencers()
      Required - API name: bucket_influencers

    • bucketSpan

      public final Time bucketSpan()
      Required - The length of the bucket in seconds. This value matches the bucket span that is specified in the job.

      API name: bucket_span

    • eventCount

      public final long eventCount()
      Required - The number of input data records processed in this bucket.

      API name: event_count

    • initialAnomalyScore

      public final double initialAnomalyScore()
      Required - The maximum anomaly score for any of the bucket influencers. This is the initial value that was calculated at the time the bucket was processed.

      API name: initial_anomaly_score

    • isInterim

      public final boolean isInterim()
      Required - If true, this is an interim result. In other words, the results are calculated based on partial input data.

      API name: is_interim

    • jobId

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

      API name: job_id

    • processingTimeMs

      public final double processingTimeMs()
      Required - The amount of time, in milliseconds, that it took to analyze the bucket contents and calculate results.

      API name: processing_time_ms

    • resultType

      public final java.lang.String resultType()
      Required - Internal. This value is always set to bucket.

      API name: result_type

    • timestamp

      public final Time timestamp()
      Required - The start time of the bucket. This timestamp uniquely identifies the bucket. Events that occur exactly at the timestamp of the bucket are included in the results for the bucket.

      API name: timestamp

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

    • setupBucketSummaryDeserializer

      protected static void setupBucketSummaryDeserializer​(ObjectDeserializer<BucketSummary.Builder> op)