The highest tagged major version isv9.
info
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Get cluster info.Returns basic information about the cluster.
Index¶
- Variables
- type Info
- func (r Info) Do(providedCtx context.Context) (*Response, error)
- func (r *Info) ErrorTrace(errortrace bool) *Info
- func (r *Info) FilterPath(filterpaths ...string) *Info
- func (r *Info) Header(key, value string) *Info
- func (r *Info) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Info) Human(human bool) *Info
- func (r Info) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Info) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Info) Pretty(pretty bool) *Info
- type NewInfo
- 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¶
typeInfo¶
type Info struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *Info
Get cluster info.Returns basic information about the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html
func (Info)Do¶
Do runs the request through the transport, handle the response and returns a info.Response
func (*Info)ErrorTrace¶added inv8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace
func (*Info)FilterPath¶added inv8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path
func (*Info)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*Info)Human¶added inv8.14.0
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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human
func (Info)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.
typeNewInfo¶
NewInfo type alias for index.
funcNewInfoFunc¶
func NewInfoFunc(tpelastictransport.Interface)NewInfo
NewInfoFunc returns a new instance of Info with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.
typeResponse¶
type Response struct {ClusterNamestring `json:"cluster_name"`Http *types.Http `json:"http,omitempty"`Ingest *types.NodesIngest `json:"ingest,omitempty"`Script *types.Scripting `json:"script,omitempty"`ThreadPool map[string]types.ThreadCount `json:"thread_pool,omitempty"`}Response holds the response body struct for the package info
Source Files