usage

Documentation

Overview

Returns information on the usage of features.

Index

• Variables
• type NewUsage
  • func NewUsageFunc(tp elastictransport.Interface) NewUsage
• type Response
  • func NewResponse() *Response
• type Usage
  • func New(tp elastictransport.Interface) *Usage
  • func (r Usage) Do(providedCtx context.Context) (*Response, error)
  • func (r *Usage) ErrorTrace(errortrace bool) *Usage
  • func (r *Usage) FilterPath(filterpaths ...string) *Usage
  • func (r *Usage) Header(key, value string) *Usage
  • func (r *Usage) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Usage) Human(human bool) *Usage
  • func (r Usage) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Usage) Metric(metric string) *Usage
  • func (r *Usage) NodeId(nodeid string) *Usage
  • func (r Usage) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Usage) Pretty(pretty bool) *Usage
  • func (r *Usage) Timeout(duration string) *Usage

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

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"`
}

Response holds the response body struct for the package usage

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/nodes/usage/NodesUsageResponse.ts#L30-L32

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Usage

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

func New

func New(tp elastictransport.Interface) *Usage

Returns information on the usage of features.

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

func (Usage) Do

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

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

func (*Usage) ErrorTrace

func (r *Usage) ErrorTrace(errortrace bool) *Usage

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Usage) FilterPath

func (r *Usage) FilterPath(filterpaths ...string) *Usage

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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

func (r *Usage) Human(human bool) *Usage

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (Usage) IsSuccess

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

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

Metric Limits the information returned to the specific metrics. A comma-separated list of the following options: `_all`, `rest_actions`. API Name: metric

func (*Usage) NodeId

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

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

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

func (*Usage) Pretty

func (r *Usage) Pretty(pretty bool) *Usage

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*Usage) Timeout

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

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