info

Documentation

Overview

Returns information about nodes in the cluster.

Index

• Variables
• type Info
  • func New(tp elastictransport.Interface) *Info
  • func (r Info) Do(ctx context.Context) (*Response, error)
  • func (r *Info) FlatSettings(b bool) *Info
  • func (r *Info) Header(key, value string) *Info
  • func (r *Info) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Info) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Info) MasterTimeout(v string) *Info
  • func (r *Info) Metric(v string) *Info
  • func (r *Info) NodeId(v string) *Info
  • func (r Info) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Info) Timeout(v 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

Returns information about nodes in the cluster.

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

func (Info) Do

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

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

func (*Info) FlatSettings

func (r *Info) FlatSettings(b 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) IsSuccess

func (r Info) IsSuccess(ctx 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(v 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(v 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(v 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(ctx context.Context) (*http.Response, error)

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

func (*Info) Timeout

func (r *Info) Timeout(v 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"`
	Nodes       map[string]types.NodeInfo `json:"nodes"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response