Package co.elastic.clients.elasticsearch.cat

Class MlJobsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cat.CatRequestBase
co.elastic.clients.elasticsearch.cat.MlJobsRequest
public class MlJobsRequest extends CatRequestBase
Get anomaly detection jobs.

Get configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have monitor_ml, monitor, manage_ml, or manage cluster privileges to use this API.

IMPORTANT: CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.

See Also:

  • Field Details

  • Method Details

    • of

      public static MlJobsRequest of(Function<MlJobsRequest.Builder,ObjectBuilder<MlJobsRequest>> fn)

    • allowNoMatch

      @Nullable public final Boolean allowNoMatch()
      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

      @Nullable public final Bytes bytes()
      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 List<CatAnomalyDetectorColumn> h()
      Comma-separated list of column names to display.

      API name: h

    • jobId

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

      API name: job_id

    • s

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

      API name: s

    • time

      @Nullable public final TimeUnit time()
      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

    • rebuild

      public MlJobsRequest.Builder rebuild()
      Returns:
      New MlJobsRequest.Builder initialized with field values of this instance