Package co.elastic.clients.elasticsearch.ml

Class GetOverallBucketsRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • jobId

      public GetOverallBucketsRequest.Builder jobId​(java.lang.String value)
      Required - Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression.

      API name: job_id

    • bucketSpan

      public GetOverallBucketsRequest.Builder bucketSpan​(@Nullable java.lang.String value)
      The span of the overall buckets. Must be greater or equal to the largest bucket span of the specified anomaly detection jobs, which is the default value.

      API name: bucket_span

    • overallScore

      public GetOverallBucketsRequest.Builder overallScore​(@Nullable java.lang.String value)
      Returns overall buckets with overall scores greater than or equal to this value.

      API name: overall_score

    • topN

      public GetOverallBucketsRequest.Builder topN​(@Nullable java.lang.Integer value)
      The number of top anomaly detection job bucket scores to be used in the overall_score calculation.

      API name: top_n

    • end

      public GetOverallBucketsRequest.Builder end​(@Nullable java.lang.String value)
      Returns overall buckets with timestamps earlier than this time.

      API name: end

    • start

      public GetOverallBucketsRequest.Builder start​(@Nullable java.lang.String value)
      Returns overall buckets with timestamps after this time.

      API name: start

    • excludeInterim

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

      API name: exclude_interim

    • allowNoMatch

      public GetOverallBucketsRequest.Builder allowNoMatch​(@Nullable java.lang.Boolean value)
      Whether to ignore if a wildcard expression matches no jobs. (This includes _all string or when no jobs have been specified)

      API name: allow_no_match

    • allowNoJobs

      public GetOverallBucketsRequest.Builder allowNoJobs​(@Nullable java.lang.Boolean value)
      API name: allow_no_jobs

    • build

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