Package co.elastic.clients.elasticsearch.ml

Class BucketInfluencer.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • anomalyScore

      public final BucketInfluencer.Builder anomalyScore​(double value)
      Required - A normalized score between 0-100, which is calculated for each bucket influencer. This score might be updated as newer data is analyzed.

      API name: anomaly_score

    • bucketSpan

      public final BucketInfluencer.Builder bucketSpan​(long 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

    • influencerFieldName

      public final BucketInfluencer.Builder influencerFieldName​(java.lang.String value)
      Required - The field name of the influencer.

      API name: influencer_field_name

    • initialAnomalyScore

      public final BucketInfluencer.Builder initialAnomalyScore​(double value)
      Required - The score between 0-100 for each bucket influencer. This score is the initial value that was calculated at the time the bucket was processed.

      API name: initial_anomaly_score

    • isInterim

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

      API name: job_id

    • probability

      public final BucketInfluencer.Builder probability​(double value)
      Required - The probability that the bucket has this behavior, in the range 0 to 1. This value can be held to a high precision of over 300 decimal places, so the anomaly_score is provided as a human-readable and friendly interpretation of this.

      API name: probability

    • rawAnomalyScore

      public final BucketInfluencer.Builder rawAnomalyScore​(double value)
      Required - Internal.

      API name: raw_anomaly_score

    • resultType

      public final BucketInfluencer.Builder resultType​(java.lang.String value)
      Required - Internal. This value is always set to bucket_influencer.

      API name: result_type

    • timestamp

      public final BucketInfluencer.Builder timestamp​(long value)
      Required - The start time of the bucket for which these results were calculated.

      API name: timestamp

    • timestampString

      public final BucketInfluencer.Builder timestampString​(@Nullable DateTime value)
      The start time of the bucket for which these results were calculated.

      API name: timestamp_string

    • self

      protected BucketInfluencer.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<BucketInfluencer.Builder>

    • build

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