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) (*http.Response, error)
  • func (r *QueryWatches) Header(key, value string) *QueryWatches
  • func (r *QueryWatches) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *QueryWatches) Raw(raw json.RawMessage) *QueryWatches
  • func (r *QueryWatches) Request(req *Request) *QueryWatches
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) From(from int) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Query(query *types.QueryContainerBuilder) *RequestBuilder
  • func (rb *RequestBuilder) SearchAfter(searchafter *types.SortResultsBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Size(size int) *RequestBuilder
  • func (rb *RequestBuilder) Sort(sort *types.SortBuilder) *RequestBuilder

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) (*http.Response, error)

Do runs the http.Request through the provided transport.

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

func (r *QueryWatches) Raw(raw json.RawMessage) *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.QueryContainer `json:"query,omitempty"`

	// SearchAfter Optional search After to do pagination using last hit’s sort values.
	SearchAfter *types.SortResults `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.Sort `json:"sort,omitempty"`
}

Request holds the request body struct for the package querywatches

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/watcher/query_watches/WatcherQueryWatchesRequest.ts#L25-L49

type RequestBuilder

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

RequestBuilder is the builder API for the querywatches.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) From

func (rb *RequestBuilder) From(from int) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Query

func (rb *RequestBuilder) Query(query *types.QueryContainerBuilder) *RequestBuilder

func (*RequestBuilder) SearchAfter

func (rb *RequestBuilder) SearchAfter(searchafter *types.SortResultsBuilder) *RequestBuilder

func (*RequestBuilder) Size

func (rb *RequestBuilder) Size(size int) *RequestBuilder

func (*RequestBuilder) Sort

func (rb *RequestBuilder) Sort(sort *types.SortBuilder) *RequestBuilder