Documentation
¶
Overview ¶
Retrieves configuration information for calendars.
Index ¶
- Variables
- type GetCalendars
- func (r *GetCalendars) CalendarId(calendarid string) *GetCalendars
- func (r GetCalendars) Do(providedCtx context.Context) (*Response, error)
- 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) Page(page *types.Page) *GetCalendars
- func (r GetCalendars) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetCalendars) Raw(raw io.Reader) *GetCalendars
- func (r *GetCalendars) Request(req *Request) *GetCalendars
- func (r *GetCalendars) Size(size int) *GetCalendars
- type NewGetCalendars
- type Request
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type GetCalendars ¶
type GetCalendars struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetCalendars
Retrieves configuration information for calendars.
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) 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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetCalendars) Page ¶ added in v8.9.0
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 ¶ added in v8.7.0
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(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
Source Files