Documentation
¶
Overview ¶
Returns basic statistics about performance of cluster nodes.
Index ¶
- Variables
- type NewNodes
- type Nodes
- func (r *Nodes) Bytes(bytes bytes.Bytes) *Nodes
- func (r Nodes) Do(providedCtx context.Context) (Response, error)
- func (r *Nodes) FullId(fullid string) *Nodes
- func (r *Nodes) Header(key, value string) *Nodes
- func (r *Nodes) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Nodes) IncludeUnloadedSegments(includeunloadedsegments bool) *Nodes
- func (r Nodes) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Nodes) Perform(providedCtx context.Context) (*http.Response, error)
- type Response
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 NewNodes ¶
type NewNodes func() *Nodes
NewNodes type alias for index.
func NewNodesFunc ¶
func NewNodesFunc(tp elastictransport.Interface) NewNodes
NewNodesFunc returns a new instance of Nodes with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Nodes ¶
type Nodes struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Nodes
Returns basic statistics about performance of cluster nodes.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html
func (Nodes) Do ¶
Do runs the request through the transport, handle the response and returns a nodes.Response
func (*Nodes) FullId ¶
FullId If `true`, return the full node ID. If `false`, return the shortened node ID. API name: full_id
func (*Nodes) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Nodes) IncludeUnloadedSegments ¶ added in v8.9.0
IncludeUnloadedSegments If true, the response includes information from segments that are not loaded into memory. API name: include_unloaded_segments
type Response ¶ added in v8.7.0
type Response []types.NodesRecord
Source Files