Documentation
¶
Overview ¶
Adds an anomaly detection job to a calendar.
Index ¶
- Variables
- type NewPutCalendarJob
- type PutCalendarJob
- func (r PutCalendarJob) Do(providedCtx context.Context) (*Response, error)
- func (r *PutCalendarJob) Header(key, value string) *PutCalendarJob
- func (r *PutCalendarJob) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r PutCalendarJob) IsSuccess(providedCtx context.Context) (bool, error)
- func (r PutCalendarJob) Perform(providedCtx context.Context) (*http.Response, error)
- 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 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) Header ¶
func (r *PutCalendarJob) Header(key, value string) *PutCalendarJob
Header set a key, value pair in the PutCalendarJob headers map.
func (*PutCalendarJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
type Response ¶ added in v8.7.0
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
Source Files