Documentation
¶
Overview ¶
Instantiates a calendar.
Index ¶
- Variables
- type NewPutCalendar
- type PutCalendar
- func (r *PutCalendar) CalendarId(v string) *PutCalendar
- func (r PutCalendar) Do(ctx context.Context) (*http.Response, error)
- func (r *PutCalendar) Header(key, value string) *PutCalendar
- func (r *PutCalendar) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutCalendar) Raw(raw json.RawMessage) *PutCalendar
- func (r *PutCalendar) Request(req *Request) *PutCalendar
- type Request
- type RequestBuilder
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) CalendarId ¶
func (r *PutCalendar) CalendarId(v string) *PutCalendar
CalendarId A string that uniquely identifies a calendar. API Name: calendarid
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) Raw ¶
func (r *PutCalendar) Raw(raw json.RawMessage) *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 []types.Id `json:"job_ids,omitempty"` }
Request holds the request body struct for the package putcalendar
type RequestBuilder ¶
type RequestBuilder struct {
// contains filtered or unexported fields
}
RequestBuilder is the builder API for the putcalendar.Request
func NewRequestBuilder ¶
func NewRequestBuilder() *RequestBuilder
NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder
func (*RequestBuilder) Build ¶
func (rb *RequestBuilder) Build() *Request
Build finalize the chain and returns the Request struct.
func (*RequestBuilder) Description ¶
func (rb *RequestBuilder) Description(description string) *RequestBuilder
func (*RequestBuilder) FromJSON ¶
func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
FromJSON allows to load an arbitrary json into the request structure
func (*RequestBuilder) JobIds ¶
func (rb *RequestBuilder) JobIds(job_ids ...types.Id) *RequestBuilder