Documentation
¶
Overview ¶
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.
Index ¶
- Variables
- type MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) AllowNoMatch(allownomatch bool) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) Bytes(bytes bytes.Bytes) *MlDataFrameAnalytics
- func (r MlDataFrameAnalytics) Do(providedCtx context.Context) (Response, error)
- func (r *MlDataFrameAnalytics) ErrorTrace(errortrace bool) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) FilterPath(filterpaths ...string) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) Format(format string) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) H(catdfacolumns ...catdfacolumn.CatDfaColumn) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) Header(key, value string) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) Help(help bool) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *MlDataFrameAnalytics) Human(human bool) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) Id(id string) *MlDataFrameAnalytics
- func (r MlDataFrameAnalytics) IsSuccess(providedCtx context.Context) (bool, error)
- func (r MlDataFrameAnalytics) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *MlDataFrameAnalytics) Pretty(pretty bool) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) S(catdfacolumns ...catdfacolumn.CatDfaColumn) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) Time(time timeunit.TimeUnit) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) V(v bool) *MlDataFrameAnalytics
- type NewMlDataFrameAnalytics
- type Response
Constants ¶
This section is empty.
Variables ¶
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")
ErrBuildPath is returned in case of missing parameters within the build of the request.
Functions ¶
This section is empty.
Types ¶
type MlDataFrameAnalytics ¶
type MlDataFrameAnalytics struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.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 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.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-data-frame-analytics
func (*MlDataFrameAnalytics) AllowNoMatch ¶
func (r *MlDataFrameAnalytics) AllowNoMatch(allownomatch bool) *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(bytes bytes.Bytes) *MlDataFrameAnalytics
Bytes The unit in which to display byte values API name: bytes
func (MlDataFrameAnalytics) Do ¶
func (r MlDataFrameAnalytics) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a mldataframeanalytics.Response
func (*MlDataFrameAnalytics) ErrorTrace ¶
func (r *MlDataFrameAnalytics) ErrorTrace(errortrace bool) *MlDataFrameAnalytics
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*MlDataFrameAnalytics) FilterPath ¶
func (r *MlDataFrameAnalytics) FilterPath(filterpaths ...string) *MlDataFrameAnalytics
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*MlDataFrameAnalytics) Format ¶
func (r *MlDataFrameAnalytics) Format(format string) *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, value string) *MlDataFrameAnalytics
Header set a key, value pair in the MlDataFrameAnalytics headers map.
func (*MlDataFrameAnalytics) Help ¶
func (r *MlDataFrameAnalytics) Help(help bool) *MlDataFrameAnalytics
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 (*MlDataFrameAnalytics) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*MlDataFrameAnalytics) Human ¶
func (r *MlDataFrameAnalytics) Human(human bool) *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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (*MlDataFrameAnalytics) Id ¶
func (r *MlDataFrameAnalytics) Id(id string) *MlDataFrameAnalytics
Id The ID of the data frame analytics to fetch API Name: id
func (MlDataFrameAnalytics) IsSuccess ¶
func (r MlDataFrameAnalytics) 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 (MlDataFrameAnalytics) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*MlDataFrameAnalytics) Pretty ¶
func (r *MlDataFrameAnalytics) Pretty(pretty bool) *MlDataFrameAnalytics
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this 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 the response. API name: s
func (*MlDataFrameAnalytics) Time ¶
func (r *MlDataFrameAnalytics) Time(time timeunit.TimeUnit) *MlDataFrameAnalytics
Time Unit used to display time values. API name: time
func (*MlDataFrameAnalytics) V ¶
func (r *MlDataFrameAnalytics) V(v bool) *MlDataFrameAnalytics
V When set to `true` will enable verbose output. API name: v
type NewMlDataFrameAnalytics ¶
type NewMlDataFrameAnalytics func() *MlDataFrameAnalytics
NewMlDataFrameAnalytics type alias for index.
func NewMlDataFrameAnalyticsFunc ¶
func NewMlDataFrameAnalyticsFunc(tp elastictransport.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 ¶
type Response []types.DataFrameAnalyticsRecord
Source Files