nodes

Documentation

Overview

Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Index

• Variables
• type NewNodes
  • func NewNodesFunc(tp elastictransport.Interface) NewNodes
• type Nodes
  • func New(tp elastictransport.Interface) *Nodes
  • func (r *Nodes) Bytes(bytes bytes.Bytes) *Nodes
  • func (r Nodes) Do(providedCtx context.Context) (Response, error)
  • func (r *Nodes) ErrorTrace(errortrace bool) *Nodes
  • func (r *Nodes) FilterPath(filterpaths ...string) *Nodes
  • func (r *Nodes) Format(format string) *Nodes
  • func (r *Nodes) FullId(fullid string) *Nodes
  • func (r *Nodes) H(names ...string) *Nodes
  • func (r *Nodes) Header(key, value string) *Nodes
  • func (r *Nodes) Help(help bool) *Nodes
  • func (r *Nodes) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Nodes) Human(human bool) *Nodes
  • func (r *Nodes) IncludeUnloadedSegments(includeunloadedsegments bool) *Nodes
  • func (r Nodes) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Nodes) Local(local bool) *Nodes
  • func (r *Nodes) MasterTimeout(duration string) *Nodes
  • func (r Nodes) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Nodes) Pretty(pretty bool) *Nodes
  • func (r *Nodes) S(names ...string) *Nodes
  • func (r *Nodes) V(v bool) *Nodes
• 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 NewNodes

type NewNodes func() *Nodes

NewNodes type alias for index.

func NewNodesFunc

func NewNodesFunc(tp elastictransport.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

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

func New

func New(tp elastictransport.Interface) *Nodes

Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application 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(bytes bytes.Bytes) *Nodes

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

func (Nodes) Do

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

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

func (*Nodes) ErrorTrace

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

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

func (*Nodes) FilterPath

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

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

func (*Nodes) Format

func (r *Nodes) Format(format string) *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(fullid string) *Nodes

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

func (*Nodes) H

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

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

func (*Nodes) Header

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

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

func (*Nodes) Help

func (r *Nodes) Help(help bool) *Nodes

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

func (*Nodes) HttpRequest

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

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

func (*Nodes) Human

func (r *Nodes) Human(human bool) *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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*Nodes) IncludeUnloadedSegments

func (r *Nodes) IncludeUnloadedSegments(includeunloadedsegments bool) *Nodes

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

func (Nodes) IsSuccess

func (r Nodes) 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 (*Nodes) Local

func (r *Nodes) Local(local bool) *Nodes

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

func (*Nodes) MasterTimeout

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

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

func (Nodes) Perform

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

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

func (*Nodes) Pretty

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

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

func (*Nodes) S

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

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 (*Nodes) V

func (r *Nodes) V(v bool) *Nodes

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

type Response

type Response []types.NodesRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response