type NewNodes func() *Nodes

funcNewNodesFunc¶

func NewNodesFunc(tpelastictransport.Interface)NewNodes

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

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

funcNew¶

func New(tpelastictransport.Interface) *Nodes

Get node information.

Get information about the nodes in 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-nodes.html

func (*Nodes)Bytes¶

func (r *Nodes) Bytes(bytesbytes.Bytes) *Nodes

Bytes The unit used to display byte values.API name: bytes

func (Nodes)Do¶

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

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

func (*Nodes)ErrorTrace¶added inv8.14.0

func (r *Nodes) ErrorTrace(errortracebool) *Nodes

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

func (*Nodes)FilterPath¶added inv8.14.0

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

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

func (*Nodes)Format¶added inv8.14.0

func (r *Nodes) Format(formatstring) *Nodes

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

func (*Nodes)FullId¶

func (r *Nodes) FullId(fullidstring) *Nodes

FullId If `true`, return the full node ID. If `false`, return the shortened node ID.API name: full_id

func (*Nodes)H¶added inv8.14.0

func (r *Nodes) H(catnodecolumns ...catnodecolumn.CatNodeColumn) *Nodes

H A comma-separated list of columns names to display.It supports simple wildcards.API name: h

func (*Nodes)Header¶

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

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

func (*Nodes)Help¶added inv8.14.0

func (r *Nodes) Help(helpbool) *Nodes

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

func (*Nodes)HttpRequest¶

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

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

func (*Nodes)Human¶added inv8.14.0

func (r *Nodes) Human(humanbool) *Nodes

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 (*Nodes)IncludeUnloadedSegments¶added inv8.9.0

func (r *Nodes) IncludeUnloadedSegments(includeunloadedsegmentsbool) *Nodes

IncludeUnloadedSegments If true, the response includes information from segments that are not loadedinto memory.API name: include_unloaded_segments

func (Nodes)IsSuccess¶

func (rNodes) 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 (*Nodes)MasterTimeout¶added inv8.14.0

func (r *Nodes) MasterTimeout(durationstring) *Nodes

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

func (Nodes)Perform¶added inv8.7.0

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

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

func (*Nodes)Pretty¶added inv8.14.0

func (r *Nodes) Pretty(prettybool) *Nodes

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

func (*Nodes)S¶added inv8.14.0

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

S A comma-separated list of column names or aliases that determines the sortorder.Sorting defaults to ascending and can be changed by setting `:asc`or `:desc` as a suffix to the column name.API name: s

func (*Nodes)Time¶added inv8.18.0

func (r *Nodes) Time(timetimeunit.TimeUnit) *Nodes

Time The unit used to display time values.API name: time

func (*Nodes)V¶added inv8.14.0

func (r *Nodes) V(vbool) *Nodes

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

type Response []types.NodesRecord

funcNewResponse¶added inv8.7.0

func NewResponse()Response

NewResponse returns a Response