The highest tagged major version is
Documentation
¶
Overview ¶
Resets an existing anomaly detection job.
Index ¶
- Variables
- type NewResetJob
- type 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
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type NewResetJob ¶
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 ¶ added in v8.7.0
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 ¶
Do runs the request through the transport, handle the response and returns a resetjob.Response
func (*ResetJob) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*ResetJob) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*ResetJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*ResetJob) Human ¶ added in v8.14.0
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 ¶
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ResetJob) Pretty ¶ added in v8.14.0
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 ¶
WaitForCompletion Should this request wait until the operation has completed before returning. API name: wait_for_completion
Source Files