openjob

Documentation

Overview

Open anomaly detection jobs. An anomaly detection job must be opened to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received.

Index

• Variables
• type NewOpenJob
  • func NewOpenJobFunc(tp elastictransport.Interface) NewOpenJob
• type OpenJob
  • func New(tp elastictransport.Interface) *OpenJob
  • func (r OpenJob) Do(providedCtx context.Context) (*Response, error)
  • func (r *OpenJob) ErrorTrace(errortrace bool) *OpenJob
  • func (r *OpenJob) FilterPath(filterpaths ...string) *OpenJob
  • func (r *OpenJob) Header(key, value string) *OpenJob
  • func (r *OpenJob) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *OpenJob) Human(human bool) *OpenJob
  • func (r OpenJob) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *OpenJob) Pretty(pretty bool) *OpenJob
  • func (r *OpenJob) Raw(raw io.Reader) *OpenJob
  • func (r *OpenJob) Request(req *Request) *OpenJob
  • func (r *OpenJob) Timeout(duration types.Duration) *OpenJob
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• 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 NewOpenJob

type NewOpenJob func(jobid string) *OpenJob

NewOpenJob type alias for index.

func NewOpenJobFunc

func NewOpenJobFunc(tp elastictransport.Interface) NewOpenJob

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

type OpenJob

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

func New

func New(tp elastictransport.Interface) *OpenJob

Open anomaly detection jobs. An anomaly detection job must be opened to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received.

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

func (OpenJob) Do

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

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

func (*OpenJob) ErrorTrace

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

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

func (*OpenJob) FilterPath

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

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

func (*OpenJob) Header

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

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

func (*OpenJob) HttpRequest

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

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

func (*OpenJob) Human

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

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 (OpenJob) Perform

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

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

func (*OpenJob) Pretty

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

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

func (*OpenJob) Raw

func (r *OpenJob) Raw(raw io.Reader) *OpenJob

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*OpenJob) Request

func (r *OpenJob) Request(req *Request) *OpenJob

Request allows to set the request property with the appropriate payload.

func (*OpenJob) Timeout

func (r *OpenJob) Timeout(duration types.Duration) *OpenJob

Timeout Refer to the description for the `timeout` query parameter. API name: timeout

type Request

type Request struct {

	// Timeout Refer to the description for the `timeout` query parameter.
	Timeout types.Duration `json:"timeout,omitempty"`
}

Request holds the request body struct for the package openjob

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/open_job/MlOpenJobRequest.ts#L24-L59

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {

	// Node The ID of the node that the job was started on. In serverless this will be
	// the "serverless".
	// If the job is allowed to open lazily and has not yet been assigned to a node,
	// this value is an empty string.
	Node   string `json:"node"`
	Opened bool   `json:"opened"`
}

Response holds the response body struct for the package openjob

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/open_job/MlOpenJobResponse.ts#L22-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response