Documentation
¶
Overview ¶
Returns different information about the cluster.
Index ¶
- Variables
- type Info
- func (r Info) Do(providedCtx context.Context) (*Response, error)
- func (r *Info) Header(key, value string) *Info
- func (r *Info) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Info) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Info) Perform(providedCtx context.Context) (*http.Response, error)
- type NewInfo
- type Response
Constants ¶
This section is empty.
Variables ¶
View Source
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
Returns different 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) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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
Click to show internal directories.
Click to hide internal directories.