resetjob

Documentation

Overview

Resets an existing anomaly detection job.

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) Header(key, value string) *ResetJob
  • func (r *ResetJob) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r ResetJob) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ResetJob) Perform(providedCtx context.Context) (*http.Response, error)
  • 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

Resets an existing anomaly detection job.

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) 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) 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) 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/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/ml/reset_job/MlResetJobResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response