health

Documentation

Overview

Returns a concise representation of the cluster health.

Index

• Variables
• type Health
  • func New(tp elastictransport.Interface) *Health
  • func (r Health) Do(ctx context.Context) (Response, error)
  • func (r *Health) Header(key, value string) *Health
  • func (r *Health) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Health) IsSuccess(ctx context.Context) (bool, error)
  • func (r Health) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Health) Time(time timeunit.TimeUnit) *Health
  • func (r *Health) Ts(ts bool) *Health
• type NewHealth
  • func NewHealthFunc(tp elastictransport.Interface) NewHealth
• 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 Health

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

func New

func New(tp elastictransport.Interface) *Health

Returns a concise representation of the cluster health.

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

func (Health) Do

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

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

func (*Health) Header

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

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

func (*Health) HttpRequest

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

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

func (Health) IsSuccess

func (r Health) 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 (Health) Perform

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

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

func (*Health) Time

func (r *Health) Time(time timeunit.TimeUnit) *Health

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

func (*Health) Ts

func (r *Health) Ts(ts bool) *Health

Ts If true, returns `HH:MM:SS` and Unix epoch timestamps. API name: ts

type NewHealth

type NewHealth func() *Health

NewHealth type alias for index.

func NewHealthFunc

func NewHealthFunc(tp elastictransport.Interface) NewHealth

NewHealthFunc returns a new instance of Health 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.HealthRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response