Package co.elastic.clients.elasticsearch.cat

Class MlDataFrameAnalyticsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<MlDataFrameAnalyticsRequest.Builder>

co.elastic.clients.elasticsearch.cat.MlDataFrameAnalyticsRequest.Builder

All Implemented Interfaces:

WithJson<MlDataFrameAnalyticsRequest.Builder>, ObjectBuilder<MlDataFrameAnalyticsRequest>

Enclosing class:

MlDataFrameAnalyticsRequest

public static class MlDataFrameAnalyticsRequest.Builder
extends CatRequestBase.AbstractBuilder<MlDataFrameAnalyticsRequest.Builder>
implements ObjectBuilder<MlDataFrameAnalyticsRequest>

Builder for MlDataFrameAnalyticsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoMatch

public final MlDataFrameAnalyticsRequest.Builder allowNoMatch(@Nullable
 Boolean value)

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

public final MlDataFrameAnalyticsRequest.Builder bytes(@Nullable
 Bytes value)

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 MlDataFrameAnalyticsRequest.Builder h(List<CatDfaColumn> list)

Comma-separated list of column names to display.

API name: h

Adds all elements of list to h.

h

public final MlDataFrameAnalyticsRequest.Builder h(CatDfaColumn value,
 CatDfaColumn... values)

Comma-separated list of column names to display.

API name: h

Adds one or more values to h.

id

public final MlDataFrameAnalyticsRequest.Builder id(@Nullable
 String value)

The ID of the data frame analytics to fetch

API name: id

s

public final MlDataFrameAnalyticsRequest.Builder s(List<CatDfaColumn> list)

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

API name: s

Adds all elements of list to s.

s

public final MlDataFrameAnalyticsRequest.Builder s(CatDfaColumn value,
 CatDfaColumn... values)

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

API name: s

Adds one or more values to s.

time

public final MlDataFrameAnalyticsRequest.Builder time(@Nullable
 TimeUnit value)

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

self

protected MlDataFrameAnalyticsRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<MlDataFrameAnalyticsRequest.Builder>

build

public MlDataFrameAnalyticsRequest build()

Builds a MlDataFrameAnalyticsRequest.

Specified by:

build in interface ObjectBuilder<MlDataFrameAnalyticsRequest>

Throws:

NullPointerException - if some of the required fields are null.