type MlDataFrameAnalytics struct {// contains filtered or unexported fields}

funcNew¶

func New(tpelastictransport.Interface) *MlDataFrameAnalytics

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 Kibanaconsole or command line. They are not intended for use by applications. Forapplication consumption, use the get data frame analytics jobs statisticsAPI.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html

func (*MlDataFrameAnalytics)AllowNoMatch¶

func (r *MlDataFrameAnalytics) AllowNoMatch(allownomatchbool) *MlDataFrameAnalytics

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

func (*MlDataFrameAnalytics)Bytes¶

func (r *MlDataFrameAnalytics) Bytes(bytesbytes.Bytes) *MlDataFrameAnalytics

Bytes The unit in which to display byte valuesAPI name: bytes

func (MlDataFrameAnalytics)Do¶

func (rMlDataFrameAnalytics) Do(providedCtxcontext.Context) (Response,error)

Do runs the request through the transport, handle the response and returns a mldataframeanalytics.Response

func (*MlDataFrameAnalytics)ErrorTrace¶added inv8.14.0

func (r *MlDataFrameAnalytics) ErrorTrace(errortracebool) *MlDataFrameAnalytics

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace

func (*MlDataFrameAnalytics)FilterPath¶added inv8.14.0

func (r *MlDataFrameAnalytics) FilterPath(filterpaths ...string) *MlDataFrameAnalytics

FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path

func (*MlDataFrameAnalytics)Format¶added inv8.14.0

func (r *MlDataFrameAnalytics) Format(formatstring) *MlDataFrameAnalytics

Format Specifies the format to return the columnar data in, can be set to`text`, `json`, `cbor`, `yaml`, or `smile`.API name: format

func (*MlDataFrameAnalytics)H¶

func (r *MlDataFrameAnalytics) H(catdfacolumns ...catdfacolumn.CatDfaColumn) *MlDataFrameAnalytics

H Comma-separated list of column names to display.API name: h

func (*MlDataFrameAnalytics)Header¶

func (r *MlDataFrameAnalytics) Header(key, valuestring) *MlDataFrameAnalytics

Header set a key, value pair in the MlDataFrameAnalytics headers map.

func (*MlDataFrameAnalytics)Help¶added inv8.14.0

func (r *MlDataFrameAnalytics) Help(helpbool) *MlDataFrameAnalytics

Help When set to `true` will output available columns. This optioncan't be combined with any other query string option.API name: help

func (*MlDataFrameAnalytics)HttpRequest¶

func (r *MlDataFrameAnalytics) HttpRequest(ctxcontext.Context) (*http.Request,error)

HttpRequest returns the http.Request object built from thegiven parameters.

func (*MlDataFrameAnalytics)Human¶added inv8.14.0

func (r *MlDataFrameAnalytics) Human(humanbool) *MlDataFrameAnalytics

Human When set to `true` will return statistics in a format suitable for humans.For example `"exists_time": "1h"` for humans and`"eixsts_time_in_millis": 3600000` for computers. When disabled the humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (*MlDataFrameAnalytics)Id¶

func (r *MlDataFrameAnalytics) Id(idstring) *MlDataFrameAnalytics

Id The ID of the data frame analytics to fetchAPI Name: id

func (MlDataFrameAnalytics)IsSuccess¶

func (rMlDataFrameAnalytics) IsSuccess(providedCtxcontext.Context) (bool,error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean.This only exists for endpoints without a request payload and allows for quick control flow.

func (MlDataFrameAnalytics)Perform¶added inv8.7.0

func (rMlDataFrameAnalytics) Perform(providedCtxcontext.Context) (*http.Response,error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*MlDataFrameAnalytics)Pretty¶added inv8.14.0

func (r *MlDataFrameAnalytics) Pretty(prettybool) *MlDataFrameAnalytics

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty

func (*MlDataFrameAnalytics)S¶

func (r *MlDataFrameAnalytics) S(catdfacolumns ...catdfacolumn.CatDfaColumn) *MlDataFrameAnalytics

S Comma-separated list of column names or column aliases used to sort theresponse.API name: s

func (*MlDataFrameAnalytics)Time¶

func (r *MlDataFrameAnalytics) Time(timetimeunit.TimeUnit) *MlDataFrameAnalytics

Time Unit used to display time values.API name: time

func (*MlDataFrameAnalytics)V¶added inv8.14.0

func (r *MlDataFrameAnalytics) V(vbool) *MlDataFrameAnalytics

V When set to `true` will enable verbose output.API name: v

type NewMlDataFrameAnalytics func() *MlDataFrameAnalytics

funcNewMlDataFrameAnalyticsFunc¶

func NewMlDataFrameAnalyticsFunc(tpelastictransport.Interface)NewMlDataFrameAnalytics

NewMlDataFrameAnalyticsFunc returns a new instance of MlDataFrameAnalytics with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.

type Response []types.DataFrameAnalyticsRecord

funcNewResponse¶added inv8.7.0

func NewResponse()Response

NewResponse returns a Response