type NewPing func() *Ping

funcNewPingFunc¶

func NewPingFunc(tpelastictransport.Interface)NewPing

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

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

funcNew¶

func New(tpelastictransport.Interface) *Ping

Ping the cluster.Get information about whether the cluster is running.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html

func (Ping)Do¶

func (rPing) Do(ctxcontext.Context) (bool,error)

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

func (*Ping)ErrorTrace¶added inv8.14.0

func (r *Ping) ErrorTrace(errortracebool) *Ping

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

func (*Ping)FilterPath¶added inv8.14.0

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

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

func (*Ping)Header¶

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

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

func (*Ping)HttpRequest¶

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

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

func (*Ping)Human¶added inv8.14.0

func (r *Ping) Human(humanbool) *Ping

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

func (rPing) 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 (Ping)Perform¶added inv8.7.0

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

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

func (*Ping)Pretty¶added inv8.14.0

func (r *Ping) Pretty(prettybool) *Ping

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