putcalendar

Documentation

Overview

Instantiates a calendar.

Index

• Variables
• type NewPutCalendar
  • func NewPutCalendarFunc(tp elastictransport.Interface) NewPutCalendar
• type PutCalendar
  • func New(tp elastictransport.Interface) *PutCalendar
  • func (r *PutCalendar) Description(description string) *PutCalendar
  • func (r PutCalendar) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutCalendar) Header(key, value string) *PutCalendar
  • func (r *PutCalendar) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutCalendar) JobIds(jobids ...string) *PutCalendar
  • func (r PutCalendar) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutCalendar) Raw(raw io.Reader) *PutCalendar
  • func (r *PutCalendar) Request(req *Request) *PutCalendar
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
  • func (s *Response) UnmarshalJSON(data []byte) error

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 NewPutCalendar

type NewPutCalendar func(calendarid string) *PutCalendar

NewPutCalendar type alias for index.

func NewPutCalendarFunc

func NewPutCalendarFunc(tp elastictransport.Interface) NewPutCalendar

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

type PutCalendar

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

func New

func New(tp elastictransport.Interface) *PutCalendar

Instantiates a calendar.

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

func (*PutCalendar) Description

func (r *PutCalendar) Description(description string) *PutCalendar

Description A description of the calendar. API name: description

func (PutCalendar) Do

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

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

func (*PutCalendar) Header

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

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

func (*PutCalendar) HttpRequest

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

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

func (*PutCalendar) JobIds

func (r *PutCalendar) JobIds(jobids ...string) *PutCalendar

JobIds An array of anomaly detection job identifiers. API name: job_ids

func (PutCalendar) Perform

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

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

func (*PutCalendar) Raw

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

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

func (*PutCalendar) Request

func (r *PutCalendar) Request(req *Request) *PutCalendar

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

type Request

type Request struct {

	// Description A description of the calendar.
	Description *string `json:"description,omitempty"`
	// JobIds An array of anomaly detection job identifiers.
	JobIds []string `json:"job_ids,omitempty"`
}

Request holds the request body struct for the package putcalendar

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/ml/put_calendar/MlPutCalendarRequest.ts#L23-L43

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 {

	// CalendarId A string that uniquely identifies a calendar.
	CalendarId string `json:"calendar_id"`
	// Description A description of the calendar.
	Description *string `json:"description,omitempty"`
	// JobIds A list of anomaly detection job identifiers or group names.
	JobIds []string `json:"job_ids"`
}

Response holds the response body struct for the package putcalendar

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/ml/put_calendar/MlPutCalendarResponse.ts#L22-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

func (s *Response) UnmarshalJSON(data []byte) error