postcalendarevents

Documentation

Overview

Add scheduled events to the calendar.

Index

• Variables
• type NewPostCalendarEvents
  • func NewPostCalendarEventsFunc(tp elastictransport.Interface) NewPostCalendarEvents
• type PostCalendarEvents
  • func New(tp elastictransport.Interface) *PostCalendarEvents
  • func (r PostCalendarEvents) Do(providedCtx context.Context) (*Response, error)
  • func (r *PostCalendarEvents) ErrorTrace(errortrace bool) *PostCalendarEvents
  • func (r *PostCalendarEvents) Events(events ...types.CalendarEvent) *PostCalendarEvents
  • func (r *PostCalendarEvents) FilterPath(filterpaths ...string) *PostCalendarEvents
  • func (r *PostCalendarEvents) Header(key, value string) *PostCalendarEvents
  • func (r *PostCalendarEvents) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PostCalendarEvents) Human(human bool) *PostCalendarEvents
  • func (r PostCalendarEvents) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PostCalendarEvents) Pretty(pretty bool) *PostCalendarEvents
  • func (r *PostCalendarEvents) Raw(raw io.Reader) *PostCalendarEvents
  • func (r *PostCalendarEvents) Request(req *Request) *PostCalendarEvents
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response

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 NewPostCalendarEvents

type NewPostCalendarEvents func(calendarid string) *PostCalendarEvents

NewPostCalendarEvents type alias for index.

func NewPostCalendarEventsFunc

func NewPostCalendarEventsFunc(tp elastictransport.Interface) NewPostCalendarEvents

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

type PostCalendarEvents

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

func New

func New(tp elastictransport.Interface) *PostCalendarEvents

Add scheduled events to the calendar.

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

func (PostCalendarEvents) Do

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

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

func (*PostCalendarEvents) ErrorTrace

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

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

func (*PostCalendarEvents) Events

func (r *PostCalendarEvents) Events(events ...types.CalendarEvent) *PostCalendarEvents

Events A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format. API name: events

func (*PostCalendarEvents) FilterPath

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

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

func (*PostCalendarEvents) Header

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

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

func (*PostCalendarEvents) HttpRequest

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

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

func (*PostCalendarEvents) Human

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

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 (PostCalendarEvents) Perform

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

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

func (*PostCalendarEvents) Pretty

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

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

func (*PostCalendarEvents) Raw

func (r *PostCalendarEvents) Raw(raw io.Reader) *PostCalendarEvents

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*PostCalendarEvents) Request

func (r *PostCalendarEvents) Request(req *Request) *PostCalendarEvents

Request allows to set the request property with the appropriate payload.

type Request

type Request struct {

	// Events A list of one of more scheduled events. The event’s start and end times can
	// be specified as integer milliseconds since the epoch or as a string in ISO
	// 8601 format.
	Events []types.CalendarEvent `json:"events"`
}

Request holds the request body struct for the package postcalendarevents

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L41

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Events []types.CalendarEvent `json:"events"`
}

Response holds the response body struct for the package postcalendarevents

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/post_calendar_events/MlPostCalendarEventsResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response