usage

package
v8.8.2 Latest Latest
Warning

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

Go to latest
Published: Jul 5, 2023 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Overview

Returns low-level information about REST actions usage on nodes.

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 NewUsage

type NewUsage func() *Usage

NewUsage type alias for index.

func NewUsageFunc

func NewUsageFunc(tp elastictransport.Interface) NewUsage

NewUsageFunc returns a new instance of Usage 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 struct {
	ClusterName string `json:"cluster_name"`
	// NodeStats Contains statistics about the number of nodes selected by the request’s node
	// filters.
	NodeStats *types.NodeStatistics      `json:"_nodes,omitempty"`
	Nodes     map[string]types.NodeUsage `json:"nodes"`
}

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

type Usage

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

func New

Returns low-level information about REST actions usage on nodes.

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

func (Usage) Do

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

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

func (*Usage) Header

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

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

func (*Usage) HttpRequest

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

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

func (Usage) IsSuccess

func (r Usage) 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 (*Usage) Metric

func (r *Usage) Metric(v string) *Usage

Metric Limit the information returned to the specified metrics API Name: metric

func (*Usage) NodeId

func (r *Usage) NodeId(v string) *Usage

NodeId A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes API Name: nodeid

func (Usage) Perform added in v8.7.0

func (r Usage) Perform(ctx context.Context) (*http.Response, error)

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

func (*Usage) Timeout

func (r *Usage) Timeout(v string) *Usage

Timeout Explicit operation timeout API name: timeout

Jump to

Keyboard shortcuts

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