Documentation
¶
Overview ¶
Instantiates a calendar.
Index ¶
- Variables
- type NewPutCalendar
- type PutCalendar
- func (r *PutCalendar) Description(description string) *PutCalendar
- func (r PutCalendar) Do(providedCtx context.Context) (*Response, error)
- func (r *PutCalendar) Header(key, value string) *PutCalendar
- func (r *PutCalendar) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutCalendar) JobIds(jobids ...string) *PutCalendar
- func (r PutCalendar) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutCalendar) Raw(raw io.Reader) *PutCalendar
- func (r *PutCalendar) Request(req *Request) *PutCalendar
- type Request
- 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 NewPutCalendar ¶
type NewPutCalendar func(calendarid string) *PutCalendar
NewPutCalendar type alias for index.
func NewPutCalendarFunc ¶
func NewPutCalendarFunc(tp elastictransport.Interface) NewPutCalendar
NewPutCalendarFunc returns a new instance of PutCalendar with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PutCalendar ¶
type PutCalendar struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PutCalendar
Instantiates a calendar.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html
func (*PutCalendar) Description ¶ added in v8.9.0
func (r *PutCalendar) Description(description string) *PutCalendar
Description A description of the calendar. API name: description
func (PutCalendar) Do ¶
func (r PutCalendar) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a putcalendar.Response
func (*PutCalendar) Header ¶
func (r *PutCalendar) Header(key, value string) *PutCalendar
Header set a key, value pair in the PutCalendar headers map.
func (*PutCalendar) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutCalendar) JobIds ¶ added in v8.9.0
func (r *PutCalendar) JobIds(jobids ...string) *PutCalendar
JobIds An array of anomaly detection job identifiers. API name: job_ids
func (PutCalendar) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutCalendar) Raw ¶
func (r *PutCalendar) Raw(raw io.Reader) *PutCalendar
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PutCalendar) Request ¶
func (r *PutCalendar) Request(req *Request) *PutCalendar
Request allows to set the request property with the appropriate payload.
type Request ¶
type Request struct {
// Description A description of the calendar.
Description *string `json:"description,omitempty"`
// JobIds An array of anomaly detection job identifiers.
JobIds []string `json:"job_ids,omitempty"`
}
Request holds the request body struct for the package putcalendar
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 putcalendar
Source Files