Package co.elastic.clients.elasticsearch.ml

Class Influencer.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • bucketSpan

      public final Influencer.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

    • influencerScore

      public final Influencer.Builder influencerScore​(double value)
      Required - A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated across detectors. Unlike initial_influencer_score, this value is updated by a re-normalization process as new data is analyzed.

      API name: influencer_score

    • influencerFieldName

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

      API name: influencer_field_name

    • influencerFieldValue

      public final Influencer.Builder influencerFieldValue​(java.lang.String value)
      Required - The entity that influenced, contributed to, or was to blame for the anomaly.

      API name: influencer_field_value

    • initialInfluencerScore

      public final Influencer.Builder initialInfluencerScore​(double value)
      Required - A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors. This is the initial value that was calculated at the time the bucket was processed.

      API name: initial_influencer_score

    • isInterim

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

      API name: job_id

    • probability

      public final Influencer.Builder probability​(double value)
      Required - The probability that the influencer 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 influencer_score is provided as a human-readable and friendly interpretation of this value.

      API name: probability

    • resultType

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

      API name: result_type

    • timestamp

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

      API name: timestamp

    • foo

      public final Influencer.Builder foo​(@Nullable java.lang.String value)
      Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s analyzing user_name as an influencer, a field user_name is added to the result document. This information enables you to filter the anomaly results more easily.

      API name: foo

    • self

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

    • build

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