putcalendarjob

Documentation

Overview

Adds an anomaly detection job to a calendar.

Index

• Variables
• type NewPutCalendarJob
  • func NewPutCalendarJobFunc(tp elastictransport.Interface) NewPutCalendarJob
• type PutCalendarJob
  • func New(tp elastictransport.Interface) *PutCalendarJob
  • func (r PutCalendarJob) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutCalendarJob) ErrorTrace(errortrace bool) *PutCalendarJob
  • func (r *PutCalendarJob) FilterPath(filterpaths ...string) *PutCalendarJob
  • func (r *PutCalendarJob) Header(key, value string) *PutCalendarJob
  • func (r *PutCalendarJob) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutCalendarJob) Human(human bool) *PutCalendarJob
  • func (r PutCalendarJob) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r PutCalendarJob) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutCalendarJob) Pretty(pretty bool) *PutCalendarJob
• 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 NewPutCalendarJob

type NewPutCalendarJob func(calendarid, jobid string) *PutCalendarJob

NewPutCalendarJob type alias for index.

func NewPutCalendarJobFunc

func NewPutCalendarJobFunc(tp elastictransport.Interface) NewPutCalendarJob

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

type PutCalendarJob

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

func New

func New(tp elastictransport.Interface) *PutCalendarJob

Adds an anomaly detection job to a calendar.

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

func (PutCalendarJob) Do

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

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

func (*PutCalendarJob) ErrorTrace

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

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

func (*PutCalendarJob) FilterPath

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

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

func (*PutCalendarJob) Header

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

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

func (*PutCalendarJob) HttpRequest

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

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

func (*PutCalendarJob) Human

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

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

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

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

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

func (*PutCalendarJob) Pretty

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

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

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 putcalendarjob

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/ml/put_calendar_job/MlPutCalendarJobResponse.ts#L22-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

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