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

Returns 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:

API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MlJobsRequest.Builder	Builder for MlJobsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.cat.CatRequestBase

CatRequestBase.AbstractBuilder<BuilderT extends CatRequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<MlJobsRequest,MlJobsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.ml_jobs".

Method Summary

Modifier and Type	Method	Description
java.lang.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.
Bytes	bytes()	The unit used to display byte values.
java.util.List<CatAnomalyDetectorColumn>	h()	Comma-separated list of column names to display.
java.lang.String	jobId()	Identifier for the anomaly detection job.
static MlJobsRequest	of(java.util.function.Function<MlJobsRequest.Builder,ObjectBuilder<MlJobsRequest>> fn)
java.util.List<CatAnomalyDetectorColumn>	s()	Comma-separated list of column names or column aliases used to sort the response.
TimeUnit	time()	The unit used to display time values.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<MlJobsRequest,MlJobsResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.ml_jobs".

Method Details

of

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

allowNoMatch

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

The unit used to display byte values.

API name: bytes

h

public final java.util.List<CatAnomalyDetectorColumn> h()

Comma-separated list of column names to display.

API name: h

jobId

@Nullable
public final java.lang.String jobId()

Identifier for the anomaly detection job.

API name: job_id

s

public final java.util.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()

The unit used to display time values.

API name: time