deletecalendarjob

Documentation

Overview

Deletes anomaly detection jobs from a calendar.

Index

• Variables
• type DeleteCalendarJob
  • func New(tp elastictransport.Interface) *DeleteCalendarJob
  • func (r *DeleteCalendarJob) CalendarId(v string) *DeleteCalendarJob
  • func (r DeleteCalendarJob) Do(ctx context.Context) (*http.Response, error)
  • func (r *DeleteCalendarJob) Header(key, value string) *DeleteCalendarJob
  • func (r *DeleteCalendarJob) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteCalendarJob) IsSuccess(ctx context.Context) (bool, error)
  • func (r *DeleteCalendarJob) JobId(v string) *DeleteCalendarJob
• type NewDeleteCalendarJob
  • func NewDeleteCalendarJobFunc(tp elastictransport.Interface) NewDeleteCalendarJob

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 DeleteCalendarJob

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

func New

func New(tp elastictransport.Interface) *DeleteCalendarJob

Deletes anomaly detection jobs from a calendar.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-job.html

func (*DeleteCalendarJob) CalendarId

func (r *DeleteCalendarJob) CalendarId(v string) *DeleteCalendarJob

CalendarId A string that uniquely identifies a calendar. API Name: calendarid

func (DeleteCalendarJob) Do

func (r DeleteCalendarJob) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*DeleteCalendarJob) Header

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

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

func (*DeleteCalendarJob) HttpRequest

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

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

func (DeleteCalendarJob) IsSuccess

func (r DeleteCalendarJob) 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 (*DeleteCalendarJob) JobId

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

JobId An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups. API Name: jobid

type NewDeleteCalendarJob

type NewDeleteCalendarJob func(calendarid, jobid string) *DeleteCalendarJob

NewDeleteCalendarJob type alias for index.

func NewDeleteCalendarJobFunc

func NewDeleteCalendarJobFunc(tp elastictransport.Interface) NewDeleteCalendarJob

NewDeleteCalendarJobFunc returns a new instance of DeleteCalendarJob with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.