Package co.elastic.clients.elasticsearch.cat

Class MlDatafeedsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.MlDatafeedsRequest

public class MlDatafeedsRequest
extends CatRequestBase

Returns configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. 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 datafeed statistics API.

See Also:

API specification

Nested Class Summary

Nested Classes

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

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<MlDatafeedsRequest,MlDatafeedsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.ml_datafeeds".

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 datafeeds that match. Contains the _all string or no identifiers and there are no matches. Contains wildcard expressions and there are only partial matches.
java.lang.String	datafeedId()	A numerical character string that uniquely identifies the datafeed.
java.util.List<CatDatafeedColumn>	h()	Comma-separated list of column names to display.
static MlDatafeedsRequest	of(java.util.function.Function<MlDatafeedsRequest.Builder,ObjectBuilder<MlDatafeedsRequest>> fn)
java.util.List<CatDatafeedColumn>	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<MlDatafeedsRequest,MlDatafeedsResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.ml_datafeeds".

Method Details

of

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

allowNoMatch

@Nullable
public final java.lang.Boolean allowNoMatch()

Specifies what to do when the request:

• Contains wildcard expressions and there are no datafeeds 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 datafeeds 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

datafeedId

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

A numerical character string that uniquely identifies the datafeed.

API name: datafeed_id

h

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

Comma-separated list of column names to display.

API name: h

s

public final java.util.List<CatDatafeedColumn> 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