getcalendars

package
v8.8.2 Latest Latest
Warning

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

Go to latest
Published: Jul 5, 2023 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Overview

Retrieves configuration information for calendars.

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 GetCalendars

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

func (*GetCalendars) CalendarId

func (r *GetCalendars) CalendarId(v 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(ctx context.Context) (*Response, error)

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

func (*GetCalendars) From

func (r *GetCalendars) From(i 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) Perform added in v8.7.0

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

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

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(i 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/a0da620389f06553c0727f98f95e40dbb564fcca/specification/ml/get_calendars/MlGetCalendarsRequest.ts#L25-L51

func NewRequest added in v8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response added in v8.7.0

type Response struct {
	Calendars []types.Calendar `json:"calendars"`
	Count     int64            `json:"count"`
}

func NewResponse added in v8.7.0

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