Documentation
¶
Overview ¶
Retrieves usage information for datafeeds.
Index ¶
- Variables
- type 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) Header(key, value string) *GetDatafeedStats
- func (r *GetDatafeedStats) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetDatafeedStats) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetDatafeedStats) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetDatafeedStats
- 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 GetDatafeedStats ¶
type GetDatafeedStats struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetDatafeedStats
Retrieves usage information for 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) Header ¶
func (r *GetDatafeedStats) Header(key, value string) *GetDatafeedStats
Header set a key, value pair in the GetDatafeedStats headers map.
func (*GetDatafeedStats) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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 ¶ added in v8.7.0
type Response struct {
Count int64 `json:"count"`
Datafeeds []types.DatafeedStats `json:"datafeeds"`
}
Response holds the response body struct for the package getdatafeedstats
Source Files