Package co.elastic.clients.elasticsearch.ml

Class GetOverallBucketsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetOverallBucketsRequest
All Implemented Interfaces:
ElasticsearchCommonRequest, JsonpSerializable
@JsonpDeserializable
public final class GetOverallBucketsRequest
extends RequestBase
implements JsonpSerializable

  • Field Details

  • Constructor Details

  • Method Details

    • jobId

      public java.lang.String jobId()
      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

      @Nullable public java.lang.String bucketSpan()
      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

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

      API name: overall_score

    • topN

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

      API name: top_n

    • end

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

      API name: end

    • start

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

      API name: start

    • excludeInterim

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

      API name: exclude_interim

    • allowNoMatch

      @Nullable public java.lang.Boolean allowNoMatch()
      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

      @Nullable public java.lang.Boolean allowNoJobs()
      API name: allow_no_jobs

    • 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)

    • setupGetOverallBucketsRequestDeserializer

      protected static void setupGetOverallBucketsRequestDeserializer​(DelegatingDeserializer<GetOverallBucketsRequest.Builder> op)