getwatch

Documentation

Overview

Get a watch.

Index

• Variables
• type GetWatch
  • func New(tp elastictransport.Interface) *GetWatch
  • func (r GetWatch) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetWatch) ErrorTrace(errortrace bool) *GetWatch
  • func (r *GetWatch) FilterPath(filterpaths ...string) *GetWatch
  • func (r *GetWatch) Header(key, value string) *GetWatch
  • func (r *GetWatch) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetWatch) Human(human bool) *GetWatch
  • func (r GetWatch) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetWatch) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetWatch) Pretty(pretty bool) *GetWatch
• type NewGetWatch
  • func NewGetWatchFunc(tp elastictransport.Interface) NewGetWatch
• 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 GetWatch

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

func New

func New(tp elastictransport.Interface) *GetWatch

Get a watch.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-watch

func (GetWatch) Do

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

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

func (*GetWatch) ErrorTrace

func (r *GetWatch) ErrorTrace(errortrace bool) *GetWatch

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

func (*GetWatch) FilterPath

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

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

func (*GetWatch) Header

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

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

func (*GetWatch) HttpRequest

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

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

func (*GetWatch) Human

func (r *GetWatch) Human(human bool) *GetWatch

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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (GetWatch) IsSuccess

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

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

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

func (*GetWatch) Pretty

func (r *GetWatch) Pretty(pretty bool) *GetWatch

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

type NewGetWatch

type NewGetWatch func(id string) *GetWatch

NewGetWatch type alias for index.

func NewGetWatchFunc

func NewGetWatchFunc(tp elastictransport.Interface) NewGetWatch

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

type Response

type Response struct {
	Found        bool               `json:"found"`
	Id_          string             `json:"_id"`
	PrimaryTerm_ *int               `json:"_primary_term,omitempty"`
	SeqNo_       *int64             `json:"_seq_no,omitempty"`
	Status       *types.WatchStatus `json:"status,omitempty"`
	Version_     *int64             `json:"_version,omitempty"`
	Watch        *types.Watch       `json:"watch,omitempty"`
}

Response holds the response body struct for the package getwatch

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/watcher/get_watch/GetWatchResponse.ts#L24-L34

func NewResponse

func NewResponse() *Response

NewResponse returns a Response