getcalendarevents

Documentation

Overview

Retrieves information about the scheduled events in calendars.

Index

• Variables
• type GetCalendarEvents
  • func New(tp elastictransport.Interface) *GetCalendarEvents
  • func (r GetCalendarEvents) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetCalendarEvents) End(datetime string) *GetCalendarEvents
  • func (r *GetCalendarEvents) From(from int) *GetCalendarEvents
  • func (r *GetCalendarEvents) Header(key, value string) *GetCalendarEvents
  • func (r *GetCalendarEvents) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetCalendarEvents) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetCalendarEvents) JobId(id string) *GetCalendarEvents
  • func (r GetCalendarEvents) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetCalendarEvents) Size(size int) *GetCalendarEvents
  • func (r *GetCalendarEvents) Start(datetime string) *GetCalendarEvents
• type NewGetCalendarEvents
  • func NewGetCalendarEventsFunc(tp elastictransport.Interface) NewGetCalendarEvents
• 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 GetCalendarEvents

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

func New

func New(tp elastictransport.Interface) *GetCalendarEvents

Retrieves information about the scheduled events in calendars.

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

func (GetCalendarEvents) Do

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

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

func (*GetCalendarEvents) End

func (r *GetCalendarEvents) End(datetime string) *GetCalendarEvents

End Specifies to get events with timestamps earlier than this time. API name: end

func (*GetCalendarEvents) From

func (r *GetCalendarEvents) From(from int) *GetCalendarEvents

From Skips the specified number of events. API name: from

func (*GetCalendarEvents) Header

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

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

func (*GetCalendarEvents) HttpRequest

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

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

func (GetCalendarEvents) IsSuccess

func (r GetCalendarEvents) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (*GetCalendarEvents) JobId

func (r *GetCalendarEvents) JobId(id string) *GetCalendarEvents

JobId Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`. API name: job_id

func (GetCalendarEvents) Perform

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

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

func (*GetCalendarEvents) Size

func (r *GetCalendarEvents) Size(size int) *GetCalendarEvents

Size Specifies the maximum number of events to obtain. API name: size

func (*GetCalendarEvents) Start

func (r *GetCalendarEvents) Start(datetime string) *GetCalendarEvents

Start Specifies to get events with timestamps after this time. API name: start

type NewGetCalendarEvents

type NewGetCalendarEvents func(calendarid string) *GetCalendarEvents

NewGetCalendarEvents type alias for index.

func NewGetCalendarEventsFunc

func NewGetCalendarEventsFunc(tp elastictransport.Interface) NewGetCalendarEvents

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

type Response

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

Response holds the response body struct for the package getcalendarevents

https://github.com/elastic/elasticsearch-specification/blob/b7d4fb5356784b8bcde8d3a2d62a1fd5621ffd67/specification/ml/get_calendar_events/MlGetCalendarEventsResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response