querywatches

Documentation

Overview

Retrieves stored watches.

Index

• Variables
• type NewQueryWatches
  • func NewQueryWatchesFunc(tp elastictransport.Interface) NewQueryWatches
• type QueryWatches
  • func New(tp elastictransport.Interface) *QueryWatches
  • func (r QueryWatches) Do(providedCtx context.Context) (*Response, error)
  • func (r *QueryWatches) ErrorTrace(errortrace bool) *QueryWatches
  • func (r *QueryWatches) FilterPath(filterpaths ...string) *QueryWatches
  • func (r *QueryWatches) From(from int) *QueryWatches
  • func (r *QueryWatches) Header(key, value string) *QueryWatches
  • func (r *QueryWatches) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *QueryWatches) Human(human bool) *QueryWatches
  • func (r QueryWatches) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *QueryWatches) Pretty(pretty bool) *QueryWatches
  • func (r *QueryWatches) Query(query *types.Query) *QueryWatches
  • func (r *QueryWatches) Raw(raw io.Reader) *QueryWatches
  • func (r *QueryWatches) Request(req *Request) *QueryWatches
  • func (r *QueryWatches) SearchAfter(sortresults ...types.FieldValue) *QueryWatches
  • func (r *QueryWatches) Size(size int) *QueryWatches
  • func (r *QueryWatches) Sort(sorts ...types.SortCombinations) *QueryWatches
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) 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 NewQueryWatches

type NewQueryWatches func() *QueryWatches

NewQueryWatches type alias for index.

func NewQueryWatchesFunc

func NewQueryWatchesFunc(tp elastictransport.Interface) NewQueryWatches

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

type QueryWatches

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

func New

func New(tp elastictransport.Interface) *QueryWatches

Retrieves stored watches.

https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html

func (QueryWatches) Do

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

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

func (*QueryWatches) ErrorTrace

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

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

func (*QueryWatches) FilterPath

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

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

func (*QueryWatches) From

func (r *QueryWatches) From(from int) *QueryWatches

From The offset from the first result to fetch. Needs to be non-negative. API name: from

func (*QueryWatches) Header

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

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

func (*QueryWatches) HttpRequest

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

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

func (*QueryWatches) Human

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

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 (QueryWatches) Perform

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

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

func (*QueryWatches) Pretty

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

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

func (*QueryWatches) Query

func (r *QueryWatches) Query(query *types.Query) *QueryWatches

Query Optional, query filter watches to be returned. API name: query

func (*QueryWatches) Raw

func (r *QueryWatches) Raw(raw io.Reader) *QueryWatches

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*QueryWatches) Request

func (r *QueryWatches) Request(req *Request) *QueryWatches

Request allows to set the request property with the appropriate payload.

func (*QueryWatches) SearchAfter

func (r *QueryWatches) SearchAfter(sortresults ...types.FieldValue) *QueryWatches

SearchAfter Optional search After to do pagination using last hit’s sort values. API name: search_after

func (*QueryWatches) Size

func (r *QueryWatches) Size(size int) *QueryWatches

Size The number of hits to return. Needs to be non-negative. API name: size

func (*QueryWatches) Sort

func (r *QueryWatches) Sort(sorts ...types.SortCombinations) *QueryWatches

Sort Optional sort definition. API name: sort

type Request

type Request struct {

	// From The offset from the first result to fetch. Needs to be non-negative.
	From *int `json:"from,omitempty"`
	// Query Optional, query filter watches to be returned.
	Query *types.Query `json:"query,omitempty"`
	// SearchAfter Optional search After to do pagination using last hit’s sort values.
	SearchAfter []types.FieldValue `json:"search_after,omitempty"`
	// Size The number of hits to return. Needs to be non-negative.
	Size *int `json:"size,omitempty"`
	// Sort Optional sort definition.
	Sort []types.SortCombinations `json:"sort,omitempty"`
}

Request holds the request body struct for the package querywatches

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts#L25-L48

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
	Count   int                `json:"count"`
	Watches []types.QueryWatch `json:"watches"`
}

Response holds the response body struct for the package querywatches

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/watcher/query_watches/WatcherQueryWatchesResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response