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:
ElasticsearchCommonRequest, JsonpSerializable
@JsonpDeserializable
public final class GetInfluencersRequest
extends RequestBase
implements JsonpSerializable

  • Field Details

  • Constructor Details

  • Method Details

    • jobId

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

      API name: job_id

    • desc

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

      API name: desc

    • end

      @Nullable public java.lang.String end()
      Returns influencers with timestamps earlier than this time.

      API name: end

    • excludeInterim

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

      API name: exclude_interim

    • influencerScore

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

      API name: influencer_score

    • from

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

      API name: from

    • size

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

      API name: size

    • sort

      @Nullable public java.lang.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 java.lang.String start()
      Returns influencers with timestamps after this time.

      API name: start

    • page

      @Nullable public Page page()
      API name: page

    • 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​(DelegatingDeserializer<GetInfluencersRequest.Builder> op)