type NewThreadPool func() *ThreadPool

funcNewThreadPoolFunc¶

func NewThreadPoolFunc(tpelastictransport.Interface)NewThreadPool

NewThreadPoolFunc returns a new instance of ThreadPool with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.

type Response []types.ThreadPoolRecord

funcNewResponse¶added inv8.7.0

func NewResponse()Response

NewResponse returns a Response

type ThreadPool struct {// contains filtered or unexported fields}

funcNew¶

func New(tpelastictransport.Interface) *ThreadPool

Get thread pool statistics.

Get thread pool statistics for each node in a cluster.Returned information includes all built-in thread pools and custom threadpools.IMPORTANT: cat APIs are only intended for human consumption using the commandline or Kibana console. They are not intended for use by applications. Forapplication consumption, use the nodes info API.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html

func (ThreadPool)Do¶

func (rThreadPool) Do(providedCtxcontext.Context) (Response,error)

Do runs the request through the transport, handle the response and returns a threadpool.Response

func (*ThreadPool)ErrorTrace¶added inv8.14.0

func (r *ThreadPool) ErrorTrace(errortracebool) *ThreadPool

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace

func (*ThreadPool)FilterPath¶added inv8.14.0

func (r *ThreadPool) FilterPath(filterpaths ...string) *ThreadPool

FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path

func (*ThreadPool)Format¶added inv8.14.0

func (r *ThreadPool) Format(formatstring) *ThreadPool

Format Specifies the format to return the columnar data in, can be set to`text`, `json`, `cbor`, `yaml`, or `smile`.API name: format

func (*ThreadPool)H¶added inv8.14.0

func (r *ThreadPool) H(catthreadpoolcolumns ...catthreadpoolcolumn.CatThreadPoolColumn) *ThreadPool

H List of columns to appear in the response. Supports simple wildcards.API name: h

func (*ThreadPool)Header¶

func (r *ThreadPool) Header(key, valuestring) *ThreadPool

Header set a key, value pair in the ThreadPool headers map.

func (*ThreadPool)Help¶added inv8.14.0

func (r *ThreadPool) Help(helpbool) *ThreadPool

Help When set to `true` will output available columns. This optioncan't be combined with any other query string option.API name: help

func (*ThreadPool)HttpRequest¶

func (r *ThreadPool) HttpRequest(ctxcontext.Context) (*http.Request,error)

HttpRequest returns the http.Request object built from thegiven parameters.

func (*ThreadPool)Human¶added inv8.14.0

func (r *ThreadPool) Human(humanbool) *ThreadPool

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 (ThreadPool)IsSuccess¶

func (rThreadPool) IsSuccess(providedCtxcontext.Context) (bool,error)

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 (*ThreadPool)Local¶added inv8.14.0

func (r *ThreadPool) Local(localbool) *ThreadPool

Local If `true`, the request computes the list of selected nodes from thelocal cluster state. If `false` the list of selected nodes are computedfrom the cluster state of the master node. In both cases the coordinatingnode will send requests for further information to each selected node.API name: local

func (*ThreadPool)MasterTimeout¶added inv8.14.0

func (r *ThreadPool) MasterTimeout(durationstring) *ThreadPool

MasterTimeout The period to wait for a connection to the master node.API name: master_timeout

func (ThreadPool)Perform¶added inv8.7.0

func (rThreadPool) Perform(providedCtxcontext.Context) (*http.Response,error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*ThreadPool)Pretty¶added inv8.14.0

func (r *ThreadPool) Pretty(prettybool) *ThreadPool

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty

func (*ThreadPool)S¶added inv8.14.0

func (r *ThreadPool) S(names ...string) *ThreadPool

S A comma-separated list of column names or aliases that determines the sortorder.Sorting defaults to ascending and can be changed by setting `:asc`or `:desc` as a suffix to the column name.API name: s

func (*ThreadPool)ThreadPoolPatterns¶

func (r *ThreadPool) ThreadPoolPatterns(threadpoolpatternsstring) *ThreadPool

ThreadPoolPatterns A comma-separated list of thread pool names used to limit the request.Accepts wildcard expressions.API Name: threadpoolpatterns

func (*ThreadPool)Time¶

func (r *ThreadPool) Time(timetimeunit.TimeUnit) *ThreadPool

Time The unit used to display time values.API name: time

func (*ThreadPool)V¶added inv8.14.0

func (r *ThreadPool) V(vbool) *ThreadPool

V When set to `true` will enable verbose output.API name: v