Documentation
¶
Overview ¶
Deletes anomaly detection jobs from a calendar.
Index ¶
- Variables
- type DeleteCalendarJob
- func (r DeleteCalendarJob) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteCalendarJob) Header(key, value string) *DeleteCalendarJob
- func (r *DeleteCalendarJob) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r DeleteCalendarJob) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DeleteCalendarJob) Perform(providedCtx context.Context) (*http.Response, error)
- type NewDeleteCalendarJob
- 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 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/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) Header ¶
func (r *DeleteCalendarJob) Header(key, value string) *DeleteCalendarJob
Header set a key, value pair in the DeleteCalendarJob headers map.
func (*DeleteCalendarJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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 ¶ 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 deletecalendarjob
Source Files