mljobs

Documentation

Overview

Get anomaly detection jobs. Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.

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 anomaly detection job statistics API.

Index

• Variables
• type MlJobs
  • func New(tp elastictransport.Interface) *MlJobs
  • func (r *MlJobs) AllowNoMatch(allownomatch bool) *MlJobs
  • func (r *MlJobs) Bytes(bytes bytes.Bytes) *MlJobs
  • func (r MlJobs) Do(providedCtx context.Context) (Response, error)
  • func (r *MlJobs) ErrorTrace(errortrace bool) *MlJobs
  • func (r *MlJobs) FilterPath(filterpaths ...string) *MlJobs
  • func (r *MlJobs) Format(format string) *MlJobs
  • func (r *MlJobs) H(catanonalydetectorcolumns ...catanomalydetectorcolumn.CatAnomalyDetectorColumn) *MlJobs
  • func (r *MlJobs) Header(key, value string) *MlJobs
  • func (r *MlJobs) Help(help bool) *MlJobs
  • func (r *MlJobs) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *MlJobs) Human(human bool) *MlJobs
  • func (r MlJobs) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *MlJobs) JobId(jobid string) *MlJobs
  • func (r *MlJobs) Local(local bool) *MlJobs
  • func (r *MlJobs) MasterTimeout(duration string) *MlJobs
  • func (r MlJobs) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *MlJobs) Pretty(pretty bool) *MlJobs
  • func (r *MlJobs) S(catanonalydetectorcolumns ...catanomalydetectorcolumn.CatAnomalyDetectorColumn) *MlJobs
  • func (r *MlJobs) Time(time timeunit.TimeUnit) *MlJobs
  • func (r *MlJobs) V(v bool) *MlJobs
• type NewMlJobs
  • func NewMlJobsFunc(tp elastictransport.Interface) NewMlJobs
• type Response
  • func NewResponse() Response

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.

Types

type MlJobs

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

func New

func New(tp elastictransport.Interface) *MlJobs

Get anomaly detection jobs. Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API.

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 anomaly detection job statistics API.

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

func (*MlJobs) AllowNoMatch

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

AllowNoMatch Specifies what to do when the request:

* Contains wildcard expressions and there are no jobs 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 jobs 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 (*MlJobs) Bytes

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

Bytes The unit used to display byte values. API name: bytes

func (MlJobs) Do

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

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

func (*MlJobs) ErrorTrace

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

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

func (*MlJobs) FilterPath

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

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

func (*MlJobs) Format

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

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

func (*MlJobs) H

func (r *MlJobs) H(catanonalydetectorcolumns ...catanomalydetectorcolumn.CatAnomalyDetectorColumn) *MlJobs

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

func (*MlJobs) Header

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

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

func (*MlJobs) Help

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

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 (*MlJobs) HttpRequest

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

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

func (*MlJobs) Human

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

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 (MlJobs) IsSuccess

func (r MlJobs) 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 (*MlJobs) JobId

func (r *MlJobs) JobId(jobid string) *MlJobs

JobId Identifier for the anomaly detection job. API Name: jobid

func (*MlJobs) Local

func (r *MlJobs) Local(local bool) *MlJobs

Local If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. API name: local

func (*MlJobs) MasterTimeout

func (r *MlJobs) MasterTimeout(duration string) *MlJobs

MasterTimeout Period to wait for a connection to the master node. API name: master_timeout

func (MlJobs) Perform

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

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

func (*MlJobs) Pretty

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

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

func (*MlJobs) S

func (r *MlJobs) S(catanonalydetectorcolumns ...catanomalydetectorcolumn.CatAnomalyDetectorColumn) *MlJobs

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

func (*MlJobs) Time

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

Time The unit used to display time values. API name: time

func (*MlJobs) V

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

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

type NewMlJobs

type NewMlJobs func() *MlJobs

NewMlJobs type alias for index.

func NewMlJobsFunc

func NewMlJobsFunc(tp elastictransport.Interface) NewMlJobs

NewMlJobsFunc returns a new instance of MlJobs 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.JobsRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response