threadpool

Documentation

Overview

Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

Index

• Variables
• type NewThreadPool
  • func NewThreadPoolFunc(tp elastictransport.Interface) NewThreadPool
• type Response
  • func NewResponse() Response
• type ThreadPool
  • func New(tp elastictransport.Interface) *ThreadPool
  • func (r ThreadPool) Do(ctx context.Context) (Response, error)
  • func (r *ThreadPool) Header(key, value string) *ThreadPool
  • func (r *ThreadPool) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r ThreadPool) IsSuccess(ctx context.Context) (bool, error)
  • func (r ThreadPool) Perform(ctx context.Context) (*http.Response, error)
  • func (r *ThreadPool) ThreadPoolPatterns(threadpoolpatterns string) *ThreadPool
  • func (r *ThreadPool) Time(time timeunit.TimeUnit) *ThreadPool

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.

Types

type NewThreadPool

type NewThreadPool func() *ThreadPool

NewThreadPool type alias for index.

func NewThreadPoolFunc

func NewThreadPoolFunc(tp elastictransport.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

type Response []types.ThreadPoolRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response

type ThreadPool

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

func New

func New(tp elastictransport.Interface) *ThreadPool

Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

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

func (ThreadPool) Do

func (r ThreadPool) Do(ctx context.Context) (Response, error)

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

func (*ThreadPool) Header

func (r *ThreadPool) Header(key, value string) *ThreadPool

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

func (*ThreadPool) HttpRequest

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

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

func (ThreadPool) IsSuccess

func (r ThreadPool) IsSuccess(ctx context.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) Perform

func (r ThreadPool) Perform(ctx context.Context) (*http.Response, error)

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

func (*ThreadPool) ThreadPoolPatterns

func (r *ThreadPool) ThreadPoolPatterns(threadpoolpatterns string) *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(time timeunit.TimeUnit) *ThreadPool

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