deletecalendarjob

Documentation

Overview

Delete anomaly jobs from a calendar.

Index

• Variables
• type DeleteCalendarJob
  • func New(tp elastictransport.Interface) *DeleteCalendarJob
  • func (r DeleteCalendarJob) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteCalendarJob) ErrorTrace(errortrace bool) *DeleteCalendarJob
  • func (r *DeleteCalendarJob) FilterPath(filterpaths ...string) *DeleteCalendarJob
  • func (r *DeleteCalendarJob) Header(key, value string) *DeleteCalendarJob
  • func (r *DeleteCalendarJob) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *DeleteCalendarJob) Human(human bool) *DeleteCalendarJob
  • func (r DeleteCalendarJob) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r DeleteCalendarJob) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DeleteCalendarJob) Pretty(pretty bool) *DeleteCalendarJob
• type NewDeleteCalendarJob
  • func NewDeleteCalendarJobFunc(tp elastictransport.Interface) NewDeleteCalendarJob
• type Response
  • func NewResponse() *Response
  • func (s *Response) UnmarshalJSON(data []byte) error

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

Delete anomaly jobs from a calendar.

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

func (DeleteCalendarJob) Do

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

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

func (*DeleteCalendarJob) ErrorTrace

func (r *DeleteCalendarJob) ErrorTrace(errortrace bool) *DeleteCalendarJob

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*DeleteCalendarJob) FilterPath

func (r *DeleteCalendarJob) FilterPath(filterpaths ...string) *DeleteCalendarJob

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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) Human

func (r *DeleteCalendarJob) Human(human bool) *DeleteCalendarJob

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 (DeleteCalendarJob) IsSuccess

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

func (r DeleteCalendarJob) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*DeleteCalendarJob) Pretty

func (r *DeleteCalendarJob) Pretty(pretty bool) *DeleteCalendarJob

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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.

type Response

type Response struct {

	// CalendarId A string that uniquely identifies a calendar.
	CalendarId string `json:"calendar_id"`
	// Description A description of the calendar.
	Description *string `json:"description,omitempty"`
	// JobIds A list of anomaly detection job identifiers or group names.
	JobIds []string `json:"job_ids"`
}

Response holds the response body struct for the package deletecalendarjob

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/delete_calendar_job/MlDeleteCalendarJobResponse.ts#L22-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

func (s *Response) UnmarshalJSON(data []byte) error