Documentation
¶
Overview ¶
Gets configuration and usage information about anomaly detection jobs.
Index ¶
- Variables
- type 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) H(catanonalydetectorcolumns ...catanomalydetectorcolumn.CatAnomalyDetectorColumn) *MlJobs
- func (r *MlJobs) Header(key, value string) *MlJobs
- func (r *MlJobs) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r MlJobs) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *MlJobs) JobId(jobid string) *MlJobs
- func (r MlJobs) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *MlJobs) S(catanonalydetectorcolumns ...catanomalydetectorcolumn.CatAnomalyDetectorColumn) *MlJobs
- func (r *MlJobs) Time(time timeunit.TimeUnit) *MlJobs
- type NewMlJobs
- 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 MlJobs ¶
type MlJobs struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *MlJobs
Gets configuration and usage information about anomaly detection jobs.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html
func (*MlJobs) AllowNoMatch ¶
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) Do ¶
Do runs the request through the transport, handle the response and returns a mljobs.Response
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) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (MlJobs) IsSuccess ¶
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) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
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
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 ¶ added in v8.7.0
type Response []types.JobsRecord
Source Files