getrollupindexcaps

Documentation

Overview

Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).

Index

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

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

func New

func New(tp elastictransport.Interface) *GetRollupIndexCaps

Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).

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

func (GetRollupIndexCaps) Do

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

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

func (*GetRollupIndexCaps) ErrorTrace

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

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

func (*GetRollupIndexCaps) FilterPath

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

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

func (*GetRollupIndexCaps) Header

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

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

func (*GetRollupIndexCaps) HttpRequest

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

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

func (*GetRollupIndexCaps) Human

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

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 (GetRollupIndexCaps) IsSuccess

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

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

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

func (*GetRollupIndexCaps) Pretty

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

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

type NewGetRollupIndexCaps

type NewGetRollupIndexCaps func(index string) *GetRollupIndexCaps

NewGetRollupIndexCaps type alias for index.

func NewGetRollupIndexCapsFunc

func NewGetRollupIndexCapsFunc(tp elastictransport.Interface) NewGetRollupIndexCaps

NewGetRollupIndexCapsFunc returns a new instance of GetRollupIndexCaps 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.IndexCapabilities

func NewResponse

func NewResponse() Response

NewResponse returns a Response