getnodestats

Documentation

Overview

Retrieves transform usage information for transform nodes.

Index

• Variables
• type GetNodeStats
  • func New(tp elastictransport.Interface) *GetNodeStats
  • func (r GetNodeStats) Do(ctx context.Context) (bool, error)
  • func (r *GetNodeStats) Header(key, value string) *GetNodeStats
  • func (r *GetNodeStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetNodeStats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetNodeStats) Perform(providedCtx context.Context) (*http.Response, error)
• type NewGetNodeStats
  • func NewGetNodeStatsFunc(tp elastictransport.Interface) NewGetNodeStats

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 GetNodeStats

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

func New

func New(tp elastictransport.Interface) *GetNodeStats

Retrieves transform usage information for transform nodes.

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-node-stats.html

func (GetNodeStats) Do

func (r GetNodeStats) Do(ctx context.Context) (bool, error)

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

func (*GetNodeStats) Header

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

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

func (*GetNodeStats) HttpRequest

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

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

func (GetNodeStats) IsSuccess

func (r GetNodeStats) 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 (GetNodeStats) Perform

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

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

type NewGetNodeStats

type NewGetNodeStats func() *GetNodeStats

NewGetNodeStats type alias for index.

func NewGetNodeStatsFunc

func NewGetNodeStatsFunc(tp elastictransport.Interface) NewGetNodeStats

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