Documentation
¶
Overview ¶
Gets configuration and usage information about datafeeds.
Index ¶
- Variables
- type MlDatafeeds
- func (r *MlDatafeeds) AllowNoMatch(allownomatch bool) *MlDatafeeds
- func (r *MlDatafeeds) DatafeedId(datafeedid string) *MlDatafeeds
- func (r MlDatafeeds) Do(providedCtx context.Context) (Response, error)
- func (r *MlDatafeeds) H(catdatafeedcolumns ...catdatafeedcolumn.CatDatafeedColumn) *MlDatafeeds
- func (r *MlDatafeeds) Header(key, value string) *MlDatafeeds
- func (r *MlDatafeeds) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r MlDatafeeds) IsSuccess(providedCtx context.Context) (bool, error)
- func (r MlDatafeeds) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *MlDatafeeds) S(catdatafeedcolumns ...catdatafeedcolumn.CatDatafeedColumn) *MlDatafeeds
- func (r *MlDatafeeds) Time(time timeunit.TimeUnit) *MlDatafeeds
- type NewMlDatafeeds
- 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 MlDatafeeds ¶
type MlDatafeeds struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *MlDatafeeds
Gets configuration and usage information about datafeeds.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html
func (*MlDatafeeds) AllowNoMatch ¶
func (r *MlDatafeeds) AllowNoMatch(allownomatch bool) *MlDatafeeds
AllowNoMatch Specifies what to do when the request:
* Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches.
If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches. API name: allow_no_match
func (*MlDatafeeds) DatafeedId ¶
func (r *MlDatafeeds) DatafeedId(datafeedid string) *MlDatafeeds
DatafeedId A numerical character string that uniquely identifies the datafeed. API Name: datafeedid
func (MlDatafeeds) Do ¶
func (r MlDatafeeds) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a mldatafeeds.Response
func (*MlDatafeeds) H ¶
func (r *MlDatafeeds) H(catdatafeedcolumns ...catdatafeedcolumn.CatDatafeedColumn) *MlDatafeeds
H Comma-separated list of column names to display. API name: h
func (*MlDatafeeds) Header ¶
func (r *MlDatafeeds) Header(key, value string) *MlDatafeeds
Header set a key, value pair in the MlDatafeeds headers map.
func (*MlDatafeeds) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (MlDatafeeds) IsSuccess ¶
func (r MlDatafeeds) 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 (MlDatafeeds) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*MlDatafeeds) S ¶
func (r *MlDatafeeds) S(catdatafeedcolumns ...catdatafeedcolumn.CatDatafeedColumn) *MlDatafeeds
S Comma-separated list of column names or column aliases used to sort the response. API name: s
func (*MlDatafeeds) Time ¶
func (r *MlDatafeeds) Time(time timeunit.TimeUnit) *MlDatafeeds
Time The unit used to display time values. API name: time
type NewMlDatafeeds ¶
type NewMlDatafeeds func() *MlDatafeeds
NewMlDatafeeds type alias for index.
func NewMlDatafeedsFunc ¶
func NewMlDatafeedsFunc(tp elastictransport.Interface) NewMlDatafeeds
NewMlDatafeedsFunc returns a new instance of MlDatafeeds 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 []types.DatafeedsRecord
Source Files