getrollupcaps

Documentation

Overview

Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

Index

• Variables
• type GetRollupCaps
  • func New(tp elastictransport.Interface) *GetRollupCaps
  • func (r GetRollupCaps) Do(providedCtx context.Context) (Response, error)
  • func (r *GetRollupCaps) ErrorTrace(errortrace bool) *GetRollupCaps
  • func (r *GetRollupCaps) FilterPath(filterpaths ...string) *GetRollupCaps
  • func (r *GetRollupCaps) Header(key, value string) *GetRollupCaps
  • func (r *GetRollupCaps) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetRollupCaps) Human(human bool) *GetRollupCaps
  • func (r *GetRollupCaps) Id(id string) *GetRollupCaps
  • func (r GetRollupCaps) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetRollupCaps) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetRollupCaps) Pretty(pretty bool) *GetRollupCaps
• type NewGetRollupCaps
  • func NewGetRollupCapsFunc(tp elastictransport.Interface) NewGetRollupCaps
• 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 GetRollupCaps

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

func New

func New(tp elastictransport.Interface) *GetRollupCaps

Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.

https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-caps.html

func (GetRollupCaps) Do

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

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

func (*GetRollupCaps) ErrorTrace

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

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

func (*GetRollupCaps) FilterPath

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

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

func (*GetRollupCaps) Header

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

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

func (*GetRollupCaps) HttpRequest

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

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

func (*GetRollupCaps) Human

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

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 (*GetRollupCaps) Id

func (r *GetRollupCaps) Id(id string) *GetRollupCaps

Id Index, indices or index-pattern to return rollup capabilities for. `_all` may be used to fetch rollup capabilities from all jobs. API Name: id

func (GetRollupCaps) IsSuccess

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

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

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

func (*GetRollupCaps) Pretty

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

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

type NewGetRollupCaps

type NewGetRollupCaps func() *GetRollupCaps

NewGetRollupCaps type alias for index.

func NewGetRollupCapsFunc

func NewGetRollupCapsFunc(tp elastictransport.Interface) NewGetRollupCaps

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

type Response

type Response map[string]types.RollupCapabilities

func NewResponse

func NewResponse() Response

NewResponse returns a Response