Package co.elastic.clients.elasticsearch.cat

Class MlJobsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<MlJobsRequest.Builder>
co.elastic.clients.elasticsearch.cat.MlJobsRequest.Builder
All Implemented Interfaces:
WithJson<MlJobsRequest.Builder>, ObjectBuilder<MlJobsRequest>
Enclosing class:
MlJobsRequest
public static class MlJobsRequest.Builder extends CatRequestBase.AbstractBuilder<MlJobsRequest.Builder> implements ObjectBuilder<MlJobsRequest>
Builder for MlJobsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoMatch

      public final MlJobsRequest.Builder allowNoMatch(@Nullable Boolean value)
      Specifies what to do when the request:
      • Contains wildcard expressions and there are no jobs that match.
      • Contains the _all string or no identifiers and there are no matches.
      • Contains wildcard expressions and there are only partial matches.

      If true, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

      API name: allow_no_match

    • bytes

      public final MlJobsRequest.Builder bytes(@Nullable Bytes value)
      Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

      API name: bytes

    • h

      public final MlJobsRequest.Builder h(List<CatAnomalyDetectorColumn> list)
      Comma-separated list of column names to display.

      API name: h

      Adds all elements of list to h.

    • h

      public final MlJobsRequest.Builder h(CatAnomalyDetectorColumn value, CatAnomalyDetectorColumn... values)
      Comma-separated list of column names to display.

      API name: h

      Adds one or more values to h.

    • jobId

      public final MlJobsRequest.Builder jobId(@Nullable String value)
      Identifier for the anomaly detection job.

      API name: job_id

    • s

      public final MlJobsRequest.Builder s(List<CatAnomalyDetectorColumn> list)
      Comma-separated list of column names or column aliases used to sort the response.

      API name: s

      Adds all elements of list to s.

    • s

      public final MlJobsRequest.Builder s(CatAnomalyDetectorColumn value, CatAnomalyDetectorColumn... values)
      Comma-separated list of column names or column aliases used to sort the response.

      API name: s

      Adds one or more values to s.

    • time

      public final MlJobsRequest.Builder time(@Nullable TimeUnit value)
      Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

      API name: time

    • self

      protected MlJobsRequest.Builder self()
      Specified by:
      self in class CatRequestBase.AbstractBuilder<MlJobsRequest.Builder>

    • build

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