health

package
v8.14.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 10, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Returns a concise representation of the cluster health.

Index

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 Health

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

func New

Returns a concise representation of the cluster health.

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

func (Health) Do

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL