getjobs

Documentation

Overview

Get anomaly detection jobs configuration info. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`.

Index

• Variables
• type GetJobs
  • func New(tp elastictransport.Interface) *GetJobs
  • func (r *GetJobs) AllowNoMatch(allownomatch bool) *GetJobs
  • func (r GetJobs) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetJobs) ErrorTrace(errortrace bool) *GetJobs
  • func (r *GetJobs) ExcludeGenerated(excludegenerated bool) *GetJobs
  • func (r *GetJobs) FilterPath(filterpaths ...string) *GetJobs
  • func (r *GetJobs) Header(key, value string) *GetJobs
  • func (r *GetJobs) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetJobs) Human(human bool) *GetJobs
  • func (r GetJobs) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetJobs) JobId(jobid string) *GetJobs
  • func (r GetJobs) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetJobs) Pretty(pretty bool) *GetJobs
• type NewGetJobs
  • func NewGetJobsFunc(tp elastictransport.Interface) NewGetJobs
• 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 GetJobs

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

func New

func New(tp elastictransport.Interface) *GetJobs

Get anomaly detection jobs configuration info. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html

func (*GetJobs) AllowNoMatch

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

AllowNoMatch Specifies what to do when the request:

1. Contains wildcard expressions and there are no jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches.

The default value is `true`, which returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. API name: allow_no_match

func (GetJobs) Do

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

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

func (*GetJobs) ErrorTrace

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

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

func (*GetJobs) ExcludeGenerated

func (r *GetJobs) ExcludeGenerated(excludegenerated bool) *GetJobs

ExcludeGenerated Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. API name: exclude_generated

func (*GetJobs) FilterPath

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

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

func (*GetJobs) Header

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

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

func (*GetJobs) HttpRequest

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

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

func (*GetJobs) Human

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

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

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

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

JobId Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these options, the API returns information for all anomaly detection jobs. API Name: jobid

func (GetJobs) Perform

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

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

func (*GetJobs) Pretty

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

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

type NewGetJobs

type NewGetJobs func() *GetJobs

NewGetJobs type alias for index.

func NewGetJobsFunc

func NewGetJobsFunc(tp elastictransport.Interface) NewGetJobs

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

type Response

type Response struct {
	Count int64       `json:"count"`
	Jobs  []types.Job `json:"jobs"`
}

Response holds the response body struct for the package getjobs

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/get_jobs/MlGetJobsResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response