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(ctx context.Context) (*Response, error)
  • func (r *QueryWatches) Header(key, value string) *QueryWatches
  • func (r *QueryWatches) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r QueryWatches) Perform(ctx context.Context) (*http.Response, error)
  • func (r *QueryWatches) Raw(raw io.Reader) *QueryWatches
  • func (r *QueryWatches) Request(req *Request) *QueryWatches
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, 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(ctx context.Context) (*Response, error)

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

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

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

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

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.

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/363111664e81786557afe06e68221018847b3676/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts#L25-L49

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

type Response

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response