Package co.elastic.clients.elasticsearch.ml

Class GetBucketsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetBucketsRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class GetBucketsRequest
extends RequestBase
implements JsonpSerializable
Retrieves anomaly detection job results for one or more buckets. The API presents a chronological view of the records, grouped by bucket.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static GetBucketsRequest of​(java.util.function.Function<GetBucketsRequest.Builder,​ObjectBuilder<GetBucketsRequest>> fn)

    • anomalyScore

      @Nullable public final java.lang.Double anomalyScore()
      Refer to the description for the anomaly_score query parameter.

      API name: anomaly_score

    • desc

      @Nullable public final java.lang.Boolean desc()
      Refer to the description for the desc query parameter.

      API name: desc

    • end

      @Nullable public final java.lang.String end()
      Refer to the description for the end query parameter.

      API name: end

    • excludeInterim

      @Nullable public final java.lang.Boolean excludeInterim()
      Refer to the description for the exclude_interim query parameter.

      API name: exclude_interim

    • expand

      @Nullable public final java.lang.Boolean expand()
      Refer to the description for the expand query parameter.

      API name: expand

    • from

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

      API name: from

    • jobId

      public final java.lang.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 java.lang.Integer size()
      Specifies the maximum number of buckets to obtain.

      API name: size

    • sort

      @Nullable public final java.lang.String sort()
      Refer to the desription for the sort query parameter.

      API name: sort

    • start

      @Nullable public final java.lang.String start()
      Refer to the description for the start query parameter.

      API name: start

    • timestamp

      @Nullable public final java.lang.String timestamp()
      The timestamp of a single bucket result. If you do not specify this parameter, the API returns information about all buckets.

      API name: timestamp

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

    • setupGetBucketsRequestDeserializer

      protected static void setupGetBucketsRequestDeserializer​(ObjectDeserializer<GetBucketsRequest.Builder> op)