info

Documentation

Overview

Get node information. By default, the API returns all attributes and core settings for cluster nodes.

Index

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

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

func New

func New(tp elastictransport.Interface) *Info

Get node information. By default, the API returns all attributes and core settings for cluster nodes.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html

func (Info) Do

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

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

func (*Info) ErrorTrace

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

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

func (*Info) FilterPath

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

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

func (*Info) FlatSettings

func (r *Info) FlatSettings(flatsettings bool) *Info

FlatSettings If true, returns settings in flat format. API name: flat_settings

func (*Info) Header

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

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

func (*Info) HttpRequest

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

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

func (*Info) Human

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

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

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

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

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (*Info) Metric

func (r *Info) Metric(metric string) *Info

Metric Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. API Name: metric

func (*Info) NodeId

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

NodeId Comma-separated list of node IDs or names used to limit returned information. API Name: nodeid

func (Info) Perform

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

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

func (*Info) Pretty

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

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

func (*Info) Timeout

func (r *Info) Timeout(duration string) *Info

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

type NewInfo

type NewInfo func() *Info

NewInfo type alias for index.

func NewInfoFunc

func NewInfoFunc(tp elastictransport.Interface) NewInfo

NewInfoFunc returns a new instance of Info 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 {
	ClusterName string `json:"cluster_name"`
	// NodeStats Contains statistics about the number of nodes selected by the request’s node
	// filters.
	NodeStats *types.NodeStatistics     `json:"_nodes,omitempty"`
	Nodes     map[string]types.NodeInfo `json:"nodes"`
}

Response holds the response body struct for the package info

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/nodes/info/NodesInfoResponse.ts#L30-L32

func NewResponse

func NewResponse() *Response

NewResponse returns a Response