postcalendarevents

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Posts scheduled events in a calendar.

Index

Constants

This section is empty.

Variables

View Source
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 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 (*PostCalendarEvents) CalendarId

func (r *PostCalendarEvents) CalendarId(v string) *PostCalendarEvents

CalendarId A string that uniquely identifies a calendar. API Name: calendarid

func (PostCalendarEvents) Do

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

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

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

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

func (*PostCalendarEvents) Raw

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/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts#L24-L40

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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL