Package co.elastic.clients.elasticsearch.ml

Class GetInfluencersRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetInfluencersRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class GetInfluencersRequest extends RequestBase implements JsonpSerializable
Retrieves anomaly detection job results for one or more influencers. Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an influencer_field_name is specified in the job configuration.
See Also:

  • Field Details

  • Method Details

    • of

      public static GetInfluencersRequest of(Function<GetInfluencersRequest.Builder,ObjectBuilder<GetInfluencersRequest>> fn)

    • desc

      @Nullable public final Boolean desc()
      If true, the results are sorted in descending order.

      API name: desc

    • end

      @Nullable public final String end()
      Returns influencers with timestamps earlier than this time. The default value means it is unset and results are not limited to specific timestamps.

      API name: end

    • excludeInterim

      @Nullable public final Boolean excludeInterim()
      If true, the output excludes interim results. By default, interim results are included.

      API name: exclude_interim

    • from

      @Nullable public final Integer from()
      Skips the specified number of influencers.

      API name: from

    • influencerScore

      @Nullable public final Double influencerScore()
      Returns influencers with anomaly scores greater than or equal to this value.

      API name: influencer_score

    • jobId

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

      API name: job_id

    • page

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

    • size

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

      API name: size

    • sort

      @Nullable public final String sort()
      Specifies the sort field for the requested influencers. By default, the influencers are sorted by the influencer_score value.

      API name: sort

    • start

      @Nullable public final String start()
      Returns influencers with timestamps after this time. The default value means it is unset and results are not limited to specific timestamps.

      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)

    • setupGetInfluencersRequestDeserializer

      protected static void setupGetInfluencersRequestDeserializer(ObjectDeserializer<GetInfluencersRequest.Builder> op)