Documentation
¶
Overview ¶
Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query.
Note that only the `_id` and `metadata.*` fields are queryable or sortable.
Index ¶
- Variables
- type NewQueryWatches
- type 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.QueryVariant) *QueryWatches
- func (r *QueryWatches) Raw(raw io.Reader) *QueryWatches
- func (r *QueryWatches) Request(req *Request) *QueryWatches
- func (r *QueryWatches) SearchAfter(sortresults ...types.FieldValueVariant) *QueryWatches
- func (r *QueryWatches) Size(size int) *QueryWatches
- func (r *QueryWatches) Sort(sorts ...types.SortCombinationsVariant) *QueryWatches
- type Request
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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
Query watches. Get all registered watches in a paginated manner and optionally filter watches by a query.
Note that only the `_id` and `metadata.*` fields are queryable or sortable.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-query-watches
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
The offset from the first result to fetch. It must 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 ¶
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 ¶
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.QueryVariant) *QueryWatches
A query that filters the 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.FieldValueVariant) *QueryWatches
Retrieve the next page of hits using a set of sort values from the previous page. API name: search_after
func (*QueryWatches) Size ¶
func (r *QueryWatches) Size(size int) *QueryWatches
The number of hits to return. It must be non-negative. API name: size
func (*QueryWatches) Sort ¶
func (r *QueryWatches) Sort(sorts ...types.SortCombinationsVariant) *QueryWatches
One or more fields used to sort the search results. API name: sort
type Request ¶
type Request struct {
// From The offset from the first result to fetch.
// It must be non-negative.
From *int `json:"from,omitempty"`
// Query A query that filters the watches to be returned.
Query *types.Query `json:"query,omitempty"`
// SearchAfter Retrieve the next page of hits using a set of sort values from the previous
// page.
SearchAfter []types.FieldValue `json:"search_after,omitempty"`
// Size The number of hits to return.
// It must be non-negative.
Size *int `json:"size,omitempty"`
// Sort One or more fields used to sort the search results.
Sort []types.SortCombinations `json:"sort,omitempty"`
}
Request holds the request body struct for the package querywatches
func (*Request) UnmarshalJSON ¶
type Response ¶
type Response struct {
// Count The total number of watches found.
Count int `json:"count"`
// Watches A list of watches based on the `from`, `size`, or `search_after` request body
// parameters.
Watches []types.QueryWatch `json:"watches"`
}
Response holds the response body struct for the package querywatches
Source Files