deletejob

Documentation

Overview

Delete an anomaly detection job. All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteJob

Delete an anomaly detection job. All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request.

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

func (*DeleteJob) DeleteUserAnnotations

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

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 (DeleteJob) Do

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

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

func (*DeleteJob) ErrorTrace

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

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

func (*DeleteJob) FilterPath

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

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

func (*DeleteJob) Force

func (r *DeleteJob) Force(force bool) *DeleteJob

Force Use to forcefully delete an opened job; this method is quicker than closing and deleting the job. API name: force

func (*DeleteJob) Header

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

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

func (*DeleteJob) HttpRequest

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

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

func (*DeleteJob) Human

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

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

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

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

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

func (*DeleteJob) Pretty

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

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

func (*DeleteJob) WaitForCompletion

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

WaitForCompletion Specifies whether the request should return immediately or wait until the job deletion completes. API name: wait_for_completion

type NewDeleteJob

type NewDeleteJob func(jobid string) *DeleteJob

NewDeleteJob type alias for index.

func NewDeleteJobFunc

func NewDeleteJobFunc(tp elastictransport.Interface) NewDeleteJob

NewDeleteJobFunc returns a new instance of DeleteJob 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 {

	// 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 deletejob

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response