master

package
v8.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 17, 2024 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Overview

Returns information about the master node, including the ID, bound IP address, and name. 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

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

Types

type Master

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

func New

Returns information about the master node, including the ID, bound IP address, and name. 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-master.html

func (Master) Do

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

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

func (*Master) ErrorTrace added in v8.14.0

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

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

func (*Master) FilterPath added in v8.14.0

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

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

func (*Master) Format added in v8.14.0

func (r *Master) Format(format string) *Master

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

func (*Master) H added in v8.14.0

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

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

func (*Master) Header

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

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

func (*Master) Help added in v8.14.0

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

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 (*Master) HttpRequest

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

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

func (*Master) Human added in v8.14.0

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

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

func (r Master) 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 (*Master) Local added in v8.14.0

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

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 (*Master) MasterTimeout added in v8.14.0

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

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

func (Master) Perform added in v8.7.0

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

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

func (*Master) Pretty added in v8.14.0

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

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

func (*Master) S added in v8.14.0

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

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 (*Master) V added in v8.14.0

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

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

type NewMaster

type NewMaster func() *Master

NewMaster type alias for index.

func NewMasterFunc

func NewMasterFunc(tp elastictransport.Interface) NewMaster

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

type Response added in v8.7.0

type Response []types.MasterRecord

func NewResponse added in v8.7.0

func NewResponse() Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL