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

Get data frame analytics jobs.

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

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoMatch()	Whether to ignore if a wildcard expression matches no configs.
final Bytes	bytes()	Sets the units for columns that contain a byte-size value.
final List<CatDfaColumn>	h()	Comma-separated list of column names to display.
final String	id()	The ID of the data frame analytics to fetch
static MlDataFrameAnalyticsRequest	of(Function<MlDataFrameAnalyticsRequest.Builder,ObjectBuilder<MlDataFrameAnalyticsRequest>> fn)
final List<CatDfaColumn>	s()	Comma-separated list of column names or column aliases used to sort the response.
final TimeUnit	time()	Sets the units for columns that contain a time duration.

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(Function<MlDataFrameAnalyticsRequest.Builder,ObjectBuilder<MlDataFrameAnalyticsRequest>> fn)

allowNoMatch

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

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<CatDfaColumn> h()

Comma-separated list of column names to display.

API name: h

id

@Nullable
public final String id()

The ID of the data frame analytics to fetch

API name: id

s

public final List<CatDfaColumn> 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