Documentation
¶
Overview ¶
Returns low-level information about REST actions usage on nodes.
Index ¶
- Variables
- type NewUsage
- type Response
- type Usage
- func (r Usage) Do(providedCtx context.Context) (*Response, error)
- func (r *Usage) Header(key, value string) *Usage
- func (r *Usage) HttpRequest(ctx context.Context) (*http.Request, error)
- 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) Timeout(duration string) *Usage
Constants ¶
This section is empty.
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.
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"`
}
Response holds the response body struct for the package usage
type Usage ¶
type Usage struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Usage
Returns low-level information about REST actions usage on nodes.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html
func (Usage) Do ¶
Do runs the request through the transport, handle the response and returns a usage.Response
func (*Usage) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (Usage) IsSuccess ¶
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 ¶
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 ¶
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
Source Files