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 ¶
type Info ¶
type Info struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Info
Get cluster info. Returns basic information about the cluster.
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info
func (Info) Do ¶
Do runs the request through the transport, handle the response and returns a info.Response
func (*Info) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Info) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Info) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Info) Human ¶
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (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.
type NewInfo ¶
NewInfo type alias for index.
func NewInfoFunc ¶
func NewInfoFunc(tp elastictransport.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.
type Response ¶
type Response struct {
ClusterName string `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