nodes

Documentation

Overview

Returns basic statistics about performance of cluster nodes.

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) FullId(fullid string) *Nodes
  • func (r *Nodes) Header(key, value string) *Nodes
  • func (r *Nodes) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Nodes) IncludeUnloadedSegments(includeunloadedsegments bool) *Nodes
  • func (r Nodes) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Nodes) Perform(providedCtx context.Context) (*http.Response, error)
• 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 basic statistics about performance of cluster nodes.

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) 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) Header

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

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

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) 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) 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.

type Response

type Response []types.NodesRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response