plugins

Documentation

Overview

Returns information about installed plugins across nodes node.

Index

• Variables
• type NewPlugins
  • func NewPluginsFunc(tp elastictransport.Interface) NewPlugins
• type Plugins
  • func New(tp elastictransport.Interface) *Plugins
  • func (r Plugins) Do(providedCtx context.Context) (Response, error)
  • func (r *Plugins) Header(key, value string) *Plugins
  • func (r *Plugins) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Plugins) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Plugins) Perform(providedCtx context.Context) (*http.Response, error)
• type Response
  • func NewResponse() Response

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 NewPlugins

type NewPlugins func() *Plugins

NewPlugins type alias for index.

func NewPluginsFunc

func NewPluginsFunc(tp elastictransport.Interface) NewPlugins

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

type Plugins

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

func New

func New(tp elastictransport.Interface) *Plugins

Returns information about installed plugins across nodes node.

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

func (Plugins) Do

func (r Plugins) Do(providedCtx context.Context) (Response, error)

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

func (*Plugins) Header

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

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

func (*Plugins) HttpRequest

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

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

func (Plugins) IsSuccess

func (r Plugins) IsSuccess(providedCtx 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 (Plugins) Perform

func (r Plugins) Perform(providedCtx context.Context) (*http.Response, error)

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

type Response

type Response []types.PluginsRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response