deletecalendarevent

Documentation

Overview

Deletes scheduled events from a calendar.

Index

• Variables
• type DeleteCalendarEvent
  • func New(tp elastictransport.Interface) *DeleteCalendarEvent
  • func (r *DeleteCalendarEvent) CalendarId(v string) *DeleteCalendarEvent
  • func (r DeleteCalendarEvent) Do(ctx context.Context) (*Response, error)
  • func (r *DeleteCalendarEvent) EventId(v string) *DeleteCalendarEvent
  • func (r *DeleteCalendarEvent) Header(key, value string) *DeleteCalendarEvent
  • func (r *DeleteCalendarEvent) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteCalendarEvent) IsSuccess(ctx context.Context) (bool, error)
  • func (r DeleteCalendarEvent) Perform(ctx context.Context) (*http.Response, error)
• type NewDeleteCalendarEvent
  • func NewDeleteCalendarEventFunc(tp elastictransport.Interface) NewDeleteCalendarEvent
• 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 DeleteCalendarEvent

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

func New

func New(tp elastictransport.Interface) *DeleteCalendarEvent

Deletes scheduled events from a calendar.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-calendar-event.html

func (*DeleteCalendarEvent) CalendarId

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

CalendarId The ID of the calendar to modify API Name: calendarid

func (DeleteCalendarEvent) Do

func (r DeleteCalendarEvent) Do(ctx context.Context) (*Response, error)

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

func (*DeleteCalendarEvent) EventId

func (r *DeleteCalendarEvent) EventId(v string) *DeleteCalendarEvent

EventId The ID of the event to remove from the calendar API Name: eventid

func (*DeleteCalendarEvent) Header

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

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

func (*DeleteCalendarEvent) HttpRequest

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

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

func (DeleteCalendarEvent) IsSuccess

func (r DeleteCalendarEvent) IsSuccess(ctx 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 (DeleteCalendarEvent) Perform

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

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

type NewDeleteCalendarEvent

type NewDeleteCalendarEvent func(calendarid, eventid string) *DeleteCalendarEvent

NewDeleteCalendarEvent type alias for index.

func NewDeleteCalendarEventFunc

func NewDeleteCalendarEventFunc(tp elastictransport.Interface) NewDeleteCalendarEvent

NewDeleteCalendarEventFunc returns a new instance of DeleteCalendarEvent 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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response