getcalendars

Documentation

Overview

Get calendar configuration info.

Index

• Variables
• type GetCalendars
  • func New(tp elastictransport.Interface) *GetCalendars
  • func (r *GetCalendars) CalendarId(calendarid string) *GetCalendars
  • func (r GetCalendars) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetCalendars) ErrorTrace(errortrace bool) *GetCalendars
  • func (r *GetCalendars) FilterPath(filterpaths ...string) *GetCalendars
  • func (r *GetCalendars) From(from int) *GetCalendars
  • func (r *GetCalendars) Header(key, value string) *GetCalendars
  • func (r *GetCalendars) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetCalendars) Human(human bool) *GetCalendars
  • func (r *GetCalendars) Page(page *types.Page) *GetCalendars
  • func (r GetCalendars) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetCalendars) Pretty(pretty bool) *GetCalendars
  • func (r *GetCalendars) Raw(raw io.Reader) *GetCalendars
  • func (r *GetCalendars) Request(req *Request) *GetCalendars
  • func (r *GetCalendars) Size(size int) *GetCalendars
• type NewGetCalendars
  • func NewGetCalendarsFunc(tp elastictransport.Interface) NewGetCalendars
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• 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 GetCalendars

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

func New

func New(tp elastictransport.Interface) *GetCalendars

Get calendar configuration info.

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

func (*GetCalendars) CalendarId

func (r *GetCalendars) CalendarId(calendarid string) *GetCalendars

CalendarId A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier. API Name: calendarid

func (GetCalendars) Do

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

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

func (*GetCalendars) ErrorTrace

func (r *GetCalendars) ErrorTrace(errortrace bool) *GetCalendars

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*GetCalendars) FilterPath

func (r *GetCalendars) FilterPath(filterpaths ...string) *GetCalendars

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*GetCalendars) From

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

From Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. API name: from

func (*GetCalendars) Header

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

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

func (*GetCalendars) HttpRequest

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

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

func (*GetCalendars) Human

func (r *GetCalendars) Human(human bool) *GetCalendars

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*GetCalendars) Page

func (r *GetCalendars) Page(page *types.Page) *GetCalendars

Page This object is supported only when you omit the calendar identifier. API name: page

func (GetCalendars) Perform

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

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

func (*GetCalendars) Pretty

func (r *GetCalendars) Pretty(pretty bool) *GetCalendars

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*GetCalendars) Raw

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

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

func (*GetCalendars) Request

func (r *GetCalendars) Request(req *Request) *GetCalendars

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

func (*GetCalendars) Size

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

Size Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. API name: size

type NewGetCalendars

type NewGetCalendars func() *GetCalendars

NewGetCalendars type alias for index.

func NewGetCalendarsFunc

func NewGetCalendarsFunc(tp elastictransport.Interface) NewGetCalendars

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

type Request

type Request struct {

	// Page This object is supported only when you omit the calendar identifier.
	Page *types.Page `json:"page,omitempty"`
}

Request holds the request body struct for the package getcalendars

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/get_calendars/MlGetCalendarsRequest.ts#L25-L52

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 {
	Calendars []types.Calendar `json:"calendars"`
	Count     int64            `json:"count"`
}

Response holds the response body struct for the package getcalendars

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/get_calendars/MlGetCalendarsResponse.ts#L23-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response