deletejob

package
v0.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 5, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Deletes an existing anomaly detection job.

Index

Constants

This section is empty.

Variables

View Source
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 (*DeleteJob) DeleteUserAnnotations

func (r *DeleteJob) DeleteUserAnnotations(b 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(ctx context.Context) (*Response, error)

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

func (*DeleteJob) Force

func (r *DeleteJob) Force(b 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) IsSuccess

func (r DeleteJob) IsSuccess(ctx 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) JobId

func (r *DeleteJob) JobId(v string) *DeleteJob

JobId Identifier for the anomaly detection job. API Name: jobid

func (DeleteJob) Perform

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

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

func (*DeleteJob) WaitForCompletion

func (r *DeleteJob) WaitForCompletion(b 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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL