type NewPlugins func() *Plugins

funcNewPluginsFunc¶

func NewPluginsFunc(tpelastictransport.Interface)NewPlugins

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

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

funcNew¶

func New(tpelastictransport.Interface) *Plugins

Get plugin information.

Get a list of plugins running on each node of a cluster.IMPORTANT: cat APIs are only intended for human consumption using the commandline or Kibana console. They are not intended for use by applications. Forapplication consumption, use the nodes info API.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html

func (Plugins)Do¶

func (rPlugins) Do(providedCtxcontext.Context) (Response,error)

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

func (*Plugins)ErrorTrace¶added inv8.14.0

func (r *Plugins) ErrorTrace(errortracebool) *Plugins

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

func (*Plugins)FilterPath¶added inv8.14.0

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

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

func (*Plugins)Format¶added inv8.14.0

func (r *Plugins) Format(formatstring) *Plugins

Format Specifies the format to return the columnar data in, can be set to`text`, `json`, `cbor`, `yaml`, or `smile`.API name: format

func (*Plugins)H¶added inv8.14.0

func (r *Plugins) H(names ...string) *Plugins

H List of columns to appear in the response. Supports simple wildcards.API name: h

func (*Plugins)Header¶

func (r *Plugins) Header(key, valuestring) *Plugins

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

func (*Plugins)Help¶added inv8.14.0

func (r *Plugins) Help(helpbool) *Plugins

Help When set to `true` will output available columns. This optioncan't be combined with any other query string option.API name: help

func (*Plugins)HttpRequest¶

func (r *Plugins) HttpRequest(ctxcontext.Context) (*http.Request,error)

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

func (*Plugins)Human¶added inv8.14.0

func (r *Plugins) Human(humanbool) *Plugins

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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (*Plugins)IncludeBootstrap¶added inv8.18.0

func (r *Plugins) IncludeBootstrap(includebootstrapbool) *Plugins

IncludeBootstrap Include bootstrap plugins in the responseAPI name: include_bootstrap

func (Plugins)IsSuccess¶

func (rPlugins) IsSuccess(providedCtxcontext.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 (*Plugins)Local¶added inv8.14.0

func (r *Plugins) Local(localbool) *Plugins

Local If `true`, the request computes the list of selected nodes from thelocal cluster state. If `false` the list of selected nodes are computedfrom the cluster state of the master node. In both cases the coordinatingnode will send requests for further information to each selected node.API name: local

func (*Plugins)MasterTimeout¶added inv8.14.0

func (r *Plugins) MasterTimeout(durationstring) *Plugins

MasterTimeout Period to wait for a connection to the master node.API name: master_timeout

func (Plugins)Perform¶added inv8.7.0

func (rPlugins) Perform(providedCtxcontext.Context) (*http.Response,error)

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

func (*Plugins)Pretty¶added inv8.14.0

func (r *Plugins) Pretty(prettybool) *Plugins

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

func (*Plugins)S¶added inv8.14.0

func (r *Plugins) S(names ...string) *Plugins

S List of columns that determine how the table should be sorted.Sorting defaults to ascending and can be changed by setting `:asc`or `:desc` as a suffix to the column name.API name: s

func (*Plugins)V¶added inv8.14.0

func (r *Plugins) V(vbool) *Plugins

V When set to `true` will enable verbose output.API name: v

type Response []types.PluginsRecord

funcNewResponse¶added inv8.7.0

func NewResponse()Response

NewResponse returns a Response