nodeattrs

Documentation

Overview

Returns information about custom node attributes.

Index

• Variables
• type NewNodeattrs
  • func NewNodeattrsFunc(tp elastictransport.Interface) NewNodeattrs
• type Nodeattrs
  • func New(tp elastictransport.Interface) *Nodeattrs
  • func (r Nodeattrs) Do(ctx context.Context) (*http.Response, error)
  • func (r *Nodeattrs) Header(key, value string) *Nodeattrs
  • func (r *Nodeattrs) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Nodeattrs) IsSuccess(ctx context.Context) (bool, error)

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 NewNodeattrs

type NewNodeattrs func() *Nodeattrs

NewNodeattrs type alias for index.

func NewNodeattrsFunc

func NewNodeattrsFunc(tp elastictransport.Interface) NewNodeattrs

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

type Nodeattrs

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

func New

func New(tp elastictransport.Interface) *Nodeattrs

Returns information about custom node attributes.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-nodeattrs.html

func (Nodeattrs) Do

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

Do runs the http.Request through the provided transport.

func (*Nodeattrs) Header

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

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

func (*Nodeattrs) HttpRequest

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

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

func (Nodeattrs) IsSuccess

func (r Nodeattrs) 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.