getdatafeedstats

Documentation

Overview

Get datafeeds usage info. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.

Index

• Variables
• type GetDatafeedStats
  • func New(tp elastictransport.Interface) *GetDatafeedStats
  • func (r *GetDatafeedStats) AllowNoMatch(allownomatch bool) *GetDatafeedStats
  • func (r *GetDatafeedStats) DatafeedId(datafeedid string) *GetDatafeedStats
  • func (r GetDatafeedStats) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetDatafeedStats) ErrorTrace(errortrace bool) *GetDatafeedStats
  • func (r *GetDatafeedStats) FilterPath(filterpaths ...string) *GetDatafeedStats
  • func (r *GetDatafeedStats) Header(key, value string) *GetDatafeedStats
  • func (r *GetDatafeedStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetDatafeedStats) Human(human bool) *GetDatafeedStats
  • func (r GetDatafeedStats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetDatafeedStats) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetDatafeedStats) Pretty(pretty bool) *GetDatafeedStats
• type NewGetDatafeedStats
  • func NewGetDatafeedStatsFunc(tp elastictransport.Interface) NewGetDatafeedStats
• 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 GetDatafeedStats

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

func New

func New(tp elastictransport.Interface) *GetDatafeedStats

Get datafeeds usage info. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html

func (*GetDatafeedStats) AllowNoMatch

func (r *GetDatafeedStats) AllowNoMatch(allownomatch bool) *GetDatafeedStats

AllowNoMatch Specifies what to do when the request:

1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches.

The default value is `true`, which returns an empty `datafeeds` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. API name: allow_no_match

func (*GetDatafeedStats) DatafeedId

func (r *GetDatafeedStats) DatafeedId(datafeedid string) *GetDatafeedStats

DatafeedId Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds. API Name: datafeedid

func (GetDatafeedStats) Do

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

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

func (*GetDatafeedStats) ErrorTrace

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

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

func (*GetDatafeedStats) FilterPath

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

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

func (*GetDatafeedStats) Header

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

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

func (*GetDatafeedStats) HttpRequest

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

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

func (*GetDatafeedStats) Human

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

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 (GetDatafeedStats) IsSuccess

func (r GetDatafeedStats) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (GetDatafeedStats) Perform

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

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

func (*GetDatafeedStats) Pretty

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

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

type NewGetDatafeedStats

type NewGetDatafeedStats func() *GetDatafeedStats

NewGetDatafeedStats type alias for index.

func NewGetDatafeedStatsFunc

func NewGetDatafeedStatsFunc(tp elastictransport.Interface) NewGetDatafeedStats

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

type Response

type Response struct {
	Count     int64                 `json:"count"`
	Datafeeds []types.DatafeedStats `json:"datafeeds"`
}

Response holds the response body struct for the package getdatafeedstats

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/get_datafeed_stats/MlGetDatafeedStatsResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response