mldatafeeds

func (*MlDatafeeds) AllowNoMatch ¶

func (r *MlDatafeeds) AllowNoMatch(allownomatch bool) *MlDatafeeds

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

func (*MlDatafeeds) Bytes ¶ added in v9.2.0

func (r *MlDatafeeds) Bytes(bytes bytes.Bytes) *MlDatafeeds

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

func (*MlDatafeeds) DatafeedId ¶

func (r *MlDatafeeds) DatafeedId(datafeedid string) *MlDatafeeds

DatafeedId A numerical character string that uniquely identifies the datafeed. API Name: datafeedid

func (MlDatafeeds) Do ¶

func (r MlDatafeeds) Do(providedCtx context.Context) (Response, error)

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

func (*MlDatafeeds) ErrorTrace ¶

func (r *MlDatafeeds) ErrorTrace(errortrace bool) *MlDatafeeds

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

func (*MlDatafeeds) FilterPath ¶

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

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

func (*MlDatafeeds) Format ¶

func (r *MlDatafeeds) Format(format string) *MlDatafeeds

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

func (*MlDatafeeds) H ¶

func (r *MlDatafeeds) H(catdatafeedcolumns ...catdatafeedcolumn.CatDatafeedColumn) *MlDatafeeds

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

func (*MlDatafeeds) Header ¶

func (r *MlDatafeeds) Header(key, value string) *MlDatafeeds

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

func (*MlDatafeeds) Help ¶

func (r *MlDatafeeds) Help(help bool) *MlDatafeeds

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

func (*MlDatafeeds) HttpRequest ¶

func (r *MlDatafeeds) HttpRequest(ctx context.Context) (*http.Request, error)

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

func (*MlDatafeeds) Human ¶

func (r *MlDatafeeds) Human(human bool) *MlDatafeeds

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

func (MlDatafeeds) IsSuccess ¶

func (r MlDatafeeds) IsSuccess(providedCtx context.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 (MlDatafeeds) Perform ¶

func (r MlDatafeeds) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*MlDatafeeds) Pretty ¶

func (r *MlDatafeeds) Pretty(pretty bool) *MlDatafeeds

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

func (*MlDatafeeds) S ¶

func (r *MlDatafeeds) S(catdatafeedcolumns ...catdatafeedcolumn.CatDatafeedColumn) *MlDatafeeds

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

func (*MlDatafeeds) Time ¶

func (r *MlDatafeeds) Time(time timeunit.TimeUnit) *MlDatafeeds

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

func (*MlDatafeeds) V ¶

func (r *MlDatafeeds) V(v bool) *MlDatafeeds

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