cachestats

Documentation

Overview

Retrieve node-level cache statistics about searchable snapshots.

Index

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

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

func New

func New(tp elastictransport.Interface) *CacheStats

Retrieve node-level cache statistics about searchable snapshots.

https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html

func (CacheStats) Do

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

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

func (*CacheStats) ErrorTrace

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

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

func (*CacheStats) FilterPath

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

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

func (*CacheStats) Header

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

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

func (*CacheStats) HttpRequest

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

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

func (*CacheStats) Human

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

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

func (r CacheStats) 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 (*CacheStats) MasterTimeout

func (r *CacheStats) MasterTimeout(duration string) *CacheStats

API name: master_timeout

func (*CacheStats) NodeId

func (r *CacheStats) NodeId(nodeid string) *CacheStats

NodeId A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes API Name: nodeid

func (CacheStats) Perform

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

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

func (*CacheStats) Pretty

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

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

type NewCacheStats

type NewCacheStats func() *CacheStats

NewCacheStats type alias for index.

func NewCacheStatsFunc

func NewCacheStatsFunc(tp elastictransport.Interface) NewCacheStats

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

type Response

type Response struct {
	Nodes map[string]types.Node `json:"nodes"`
}

Response holds the response body struct for the package cachestats

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/searchable_snapshots/cache_stats/Response.ts#L24-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response