Package co.elastic.clients.elasticsearch.ml

Class BucketSummary.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.ml.BucketSummary.Builder
All Implemented Interfaces:
ObjectBuilder<BucketSummary>
Enclosing class:
BucketSummary
public static class BucketSummary.Builder
extends ObjectBuilderBase
implements ObjectBuilder<BucketSummary>
Builder for BucketSummary.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • anomalyScore

      public final BucketSummary.Builder anomalyScore​(double value)
      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 BucketSummary.Builder bucketInfluencers​(java.util.List<BucketInfluencer> list)
      Required - API name: bucket_influencers

      Adds all elements of list to bucketInfluencers.

    • bucketInfluencers

      public final BucketSummary.Builder bucketInfluencers​(BucketInfluencer value, BucketInfluencer... values)
      Required - API name: bucket_influencers

      Adds one or more values to bucketInfluencers.

    • bucketInfluencers

      public final BucketSummary.Builder bucketInfluencers​(java.util.function.Function<BucketInfluencer.Builder,​ObjectBuilder<BucketInfluencer>> fn)
      Required - API name: bucket_influencers

      Adds a value to bucketInfluencers using a builder lambda.

    • bucketSpan

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

      API name: bucket_span

    • bucketSpan

      public final BucketSummary.Builder bucketSpan​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      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 BucketSummary.Builder eventCount​(long value)
      Required - The number of input data records processed in this bucket.

      API name: event_count

    • initialAnomalyScore

      public final BucketSummary.Builder initialAnomalyScore​(double value)
      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 BucketSummary.Builder isInterim​(boolean value)
      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 BucketSummary.Builder jobId​(java.lang.String value)
      Required - Identifier for the anomaly detection job.

      API name: job_id

    • processingTimeMs

      public final BucketSummary.Builder processingTimeMs​(double value)
      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 BucketSummary.Builder resultType​(java.lang.String value)
      Required - Internal. This value is always set to bucket.

      API name: result_type

    • timestamp

      public final BucketSummary.Builder timestamp​(Time value)
      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

    • timestamp

      public final BucketSummary.Builder timestamp​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      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

    • build

      public BucketSummary build()
      Builds a BucketSummary.
      Specified by:
      build in interface ObjectBuilder<BucketSummary>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.