Package co.elastic.clients.elasticsearch.cat

Class MlDataFrameAnalyticsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cat.CatRequestBase

co.elastic.clients.elasticsearch.cat.MlDataFrameAnalyticsRequest

public class MlDataFrameAnalyticsRequest
extends CatRequestBase

Returns configuration and usage information about data frame analytics jobs.

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 data frame analytics jobs statistics API.

See Also:

API specification

Nested Class Summary

Nested Classes

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

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<MlDataFrameAnalyticsRequest,MlDataFrameAnalyticsResponse,ErrorResponse>	_ENDPOINT	Endpoint "cat.ml_data_frame_analytics".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoMatch()	Whether to ignore if a wildcard expression matches no configs.
Bytes	bytes()	The unit in which to display byte values
java.util.List<CatDfaColumn>	h()	Comma-separated list of column names to display.
java.lang.String	id()	The ID of the data frame analytics to fetch
static MlDataFrameAnalyticsRequest	of(java.util.function.Function<MlDataFrameAnalyticsRequest.Builder,ObjectBuilder<MlDataFrameAnalyticsRequest>> fn)
java.util.List<CatDfaColumn>	s()	Comma-separated list of column names or column aliases used to sort the response.
Time	time()	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<MlDataFrameAnalyticsRequest,MlDataFrameAnalyticsResponse,ErrorResponse> _ENDPOINT

Endpoint "cat.ml_data_frame_analytics".

Method Details

of

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

allowNoMatch

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

Whether to ignore if a wildcard expression matches no configs. (This includes _all string or when no configs have been specified)

API name: allow_no_match

bytes

@Nullable
public final Bytes bytes()

The unit in which to display byte values

API name: bytes

h

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

Comma-separated list of column names to display.

API name: h

id

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

The ID of the data frame analytics to fetch

API name: id

s

public final java.util.List<CatDfaColumn> s()

Comma-separated list of column names or column aliases used to sort the response.

API name: s

time

@Nullable
public final Time time()

Unit used to display time values.

API name: time