Package co.elastic.clients.elasticsearch.ml

Class GetInfluencersRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • desc

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

      API name: desc

    • end

      public final GetInfluencersRequest.Builder end​(@Nullable java.lang.String value)
      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

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

      API name: exclude_interim

    • from

      public final GetInfluencersRequest.Builder from​(@Nullable java.lang.Integer value)
      Skips the specified number of influencers.

      API name: from

    • influencerScore

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

      API name: influencer_score

    • jobId

      public final GetInfluencersRequest.Builder jobId​(java.lang.String value)
      Required - Identifier for the anomaly detection job.

      API name: job_id

    • page

      public final GetInfluencersRequest.Builder page​(@Nullable Page value)
      API name: page

    • page

      public final GetInfluencersRequest.Builder page​(java.util.function.Function<Page.Builder,​ObjectBuilder<Page>> fn)
      API name: page

    • size

      public final GetInfluencersRequest.Builder size​(@Nullable java.lang.Integer value)
      Specifies the maximum number of influencers to obtain.

      API name: size

    • sort

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

      API name: sort

    • start

      public final GetInfluencersRequest.Builder start​(@Nullable java.lang.String value)
      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

    • build

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