Documentation
¶
Overview ¶
Gets configuration and usage information about data frame analytics jobs.
Index ¶
- Variables
- type MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) AllowNoMatch(allownomatch bool) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) Bytes(bytes bytes.Bytes) *MlDataFrameAnalytics
- func (r MlDataFrameAnalytics) Do(providedCtx context.Context) (Response, error)
- func (r *MlDataFrameAnalytics) H(catdfacolumns ...catdfacolumn.CatDfaColumn) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) Header(key, value string) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *MlDataFrameAnalytics) Id(id string) *MlDataFrameAnalytics
- func (r MlDataFrameAnalytics) IsSuccess(providedCtx context.Context) (bool, error)
- func (r MlDataFrameAnalytics) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *MlDataFrameAnalytics) S(catdfacolumns ...catdfacolumn.CatDfaColumn) *MlDataFrameAnalytics
- func (r *MlDataFrameAnalytics) Time(duration string) *MlDataFrameAnalytics
- type NewMlDataFrameAnalytics
- 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 MlDataFrameAnalytics ¶
type MlDataFrameAnalytics struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *MlDataFrameAnalytics
Gets configuration and usage information about data frame analytics jobs.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html
func (*MlDataFrameAnalytics) AllowNoMatch ¶
func (r *MlDataFrameAnalytics) AllowNoMatch(allownomatch bool) *MlDataFrameAnalytics
AllowNoMatch Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) API name: allow_no_match
func (*MlDataFrameAnalytics) Bytes ¶
func (r *MlDataFrameAnalytics) Bytes(bytes bytes.Bytes) *MlDataFrameAnalytics
Bytes The unit in which to display byte values API name: bytes
func (MlDataFrameAnalytics) Do ¶
func (r MlDataFrameAnalytics) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a mldataframeanalytics.Response
func (*MlDataFrameAnalytics) H ¶
func (r *MlDataFrameAnalytics) H(catdfacolumns ...catdfacolumn.CatDfaColumn) *MlDataFrameAnalytics
H Comma-separated list of column names to display. API name: h
func (*MlDataFrameAnalytics) Header ¶
func (r *MlDataFrameAnalytics) Header(key, value string) *MlDataFrameAnalytics
Header set a key, value pair in the MlDataFrameAnalytics headers map.
func (*MlDataFrameAnalytics) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*MlDataFrameAnalytics) Id ¶
func (r *MlDataFrameAnalytics) Id(id string) *MlDataFrameAnalytics
Id The ID of the data frame analytics to fetch API Name: id
func (MlDataFrameAnalytics) IsSuccess ¶
func (r MlDataFrameAnalytics) 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 (MlDataFrameAnalytics) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*MlDataFrameAnalytics) S ¶
func (r *MlDataFrameAnalytics) S(catdfacolumns ...catdfacolumn.CatDfaColumn) *MlDataFrameAnalytics
S Comma-separated list of column names or column aliases used to sort the response. API name: s
func (*MlDataFrameAnalytics) Time ¶
func (r *MlDataFrameAnalytics) Time(duration string) *MlDataFrameAnalytics
Time Unit used to display time values. API name: time
type NewMlDataFrameAnalytics ¶
type NewMlDataFrameAnalytics func() *MlDataFrameAnalytics
NewMlDataFrameAnalytics type alias for index.
func NewMlDataFrameAnalyticsFunc ¶
func NewMlDataFrameAnalyticsFunc(tp elastictransport.Interface) NewMlDataFrameAnalytics
NewMlDataFrameAnalyticsFunc returns a new instance of MlDataFrameAnalytics 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.DataFrameAnalyticsRecord
Source Files