resetjob

Documentation

Overview

Reset an anomaly detection job. All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list.

Index

• Variables
• type NewResetJob
  • func NewResetJobFunc(tp elastictransport.Interface) NewResetJob
• type ResetJob
  • func New(tp elastictransport.Interface) *ResetJob
  • func (r *ResetJob) DeleteUserAnnotations(deleteuserannotations bool) *ResetJob
  • func (r ResetJob) Do(providedCtx context.Context) (*Response, error)
  • func (r *ResetJob) ErrorTrace(errortrace bool) *ResetJob
  • func (r *ResetJob) FilterPath(filterpaths ...string) *ResetJob
  • func (r *ResetJob) Header(key, value string) *ResetJob
  • func (r *ResetJob) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ResetJob) Human(human bool) *ResetJob
  • func (r ResetJob) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ResetJob) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ResetJob) Pretty(pretty bool) *ResetJob
  • func (r *ResetJob) WaitForCompletion(waitforcompletion bool) *ResetJob
• 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 NewResetJob

type NewResetJob func(jobid string) *ResetJob

NewResetJob type alias for index.

func NewResetJobFunc

func NewResetJobFunc(tp elastictransport.Interface) NewResetJob

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

type ResetJob

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

func New

func New(tp elastictransport.Interface) *ResetJob

Reset an anomaly detection job. All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list.

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

func (*ResetJob) DeleteUserAnnotations

func (r *ResetJob) DeleteUserAnnotations(deleteuserannotations bool) *ResetJob

DeleteUserAnnotations Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset. API name: delete_user_annotations

func (ResetJob) Do

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

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

func (*ResetJob) ErrorTrace

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

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

func (*ResetJob) FilterPath

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

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

func (*ResetJob) Header

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

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

func (*ResetJob) HttpRequest

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

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

func (*ResetJob) Human

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

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

func (r ResetJob) 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 (ResetJob) Perform

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

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

func (*ResetJob) Pretty

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

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

func (*ResetJob) WaitForCompletion

func (r *ResetJob) WaitForCompletion(waitforcompletion bool) *ResetJob

WaitForCompletion Should this request wait until the operation has completed before returning. API name: wait_for_completion

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package resetjob

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/reset_job/MlResetJobResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response