Documentation
¶
Overview ¶
Deletes an existing anomaly detection job.
Index ¶
- Variables
- type DeleteJob
- func (r *DeleteJob) DeleteUserAnnotations(deleteuserannotations bool) *DeleteJob
- func (r DeleteJob) Do(providedCtx context.Context) (*Response, error)
- 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) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DeleteJob) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteJob) WaitForCompletion(waitforcompletion bool) *DeleteJob
- type NewDeleteJob
- 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 DeleteJob ¶
type DeleteJob struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteJob
Deletes an existing anomaly detection job.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html
func (*DeleteJob) 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 (DeleteJob) Do ¶
Do runs the request through the transport, handle the response and returns a deletejob.Response
func (*DeleteJob) Force ¶
Force Use to forcefully delete an opened job; this method is quicker than closing and deleting the job. API name: force
func (*DeleteJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (DeleteJob) 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 (DeleteJob) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteJob) WaitForCompletion ¶
WaitForCompletion Specifies whether the request should return immediately or wait until the job deletion completes. API name: wait_for_completion
type NewDeleteJob ¶
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.
Source Files