Documentation
¶
Overview ¶
Retrieves stored watches.
Index ¶
- Variables
- type NewQueryWatches
- type QueryWatches
- func (r QueryWatches) Do(providedCtx context.Context) (*Response, error)
- 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) Perform(providedCtx context.Context) (*http.Response, error)
- 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
- 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
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) From ¶ added in v8.9.0
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (QueryWatches) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*QueryWatches) Query ¶ added in v8.9.0
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 ¶ added in v8.9.0
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 ¶ added in v8.9.0
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 ¶ added in v8.9.0
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
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
func (*Request) UnmarshalJSON ¶ added in v8.12.1
type Response ¶ added in v8.7.0
type Response struct {
Count int `json:"count"`
Watches []types.QueryWatch `json:"watches"`
}
Response holds the response body struct for the package querywatches
Source Files