deletecalendar

Documentation

Overview

Deletes a calendar.

Index

• Variables
• type DeleteCalendar
  • func New(tp elastictransport.Interface) *DeleteCalendar
  • func (r DeleteCalendar) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteCalendar) Header(key, value string) *DeleteCalendar
  • func (r *DeleteCalendar) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteCalendar) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r DeleteCalendar) Perform(providedCtx context.Context) (*http.Response, error)
• type NewDeleteCalendar
  • func NewDeleteCalendarFunc(tp elastictransport.Interface) NewDeleteCalendar
• 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 DeleteCalendar

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

func New

func New(tp elastictransport.Interface) *DeleteCalendar

Deletes a calendar.

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

func (DeleteCalendar) Do

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

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

func (*DeleteCalendar) Header

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

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

func (*DeleteCalendar) HttpRequest

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

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

func (DeleteCalendar) IsSuccess

func (r DeleteCalendar) 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 (DeleteCalendar) Perform

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

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

type NewDeleteCalendar

type NewDeleteCalendar func(calendarid string) *DeleteCalendar

NewDeleteCalendar type alias for index.

func NewDeleteCalendarFunc

func NewDeleteCalendarFunc(tp elastictransport.Interface) NewDeleteCalendar

NewDeleteCalendarFunc returns a new instance of DeleteCalendar 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"`
}

Response holds the response body struct for the package deletecalendar

https://github.com/elastic/elasticsearch-specification/blob/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/ml/delete_calendar/MlDeleteCalendarResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response