mldataframeanalytics

Documentation

Overview

Gets configuration and usage information about data frame analytics jobs.

Index

• Variables
• type MlDataFrameAnalytics
  • func New(tp elastictransport.Interface) *MlDataFrameAnalytics
  • func (r *MlDataFrameAnalytics) AllowNoMatch(b bool) *MlDataFrameAnalytics
  • func (r *MlDataFrameAnalytics) Bytes(enum bytes.Bytes) *MlDataFrameAnalytics
  • func (r MlDataFrameAnalytics) Do(ctx context.Context) (Response, error)
  • func (r *MlDataFrameAnalytics) H(v string) *MlDataFrameAnalytics
  • func (r *MlDataFrameAnalytics) Header(key, value string) *MlDataFrameAnalytics
  • func (r *MlDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *MlDataFrameAnalytics) Id(v string) *MlDataFrameAnalytics
  • func (r MlDataFrameAnalytics) IsSuccess(ctx context.Context) (bool, error)
  • func (r MlDataFrameAnalytics) Perform(ctx context.Context) (*http.Response, error)
  • func (r *MlDataFrameAnalytics) S(v string) *MlDataFrameAnalytics
  • func (r *MlDataFrameAnalytics) Time(v string) *MlDataFrameAnalytics
• type NewMlDataFrameAnalytics
  • func NewMlDataFrameAnalyticsFunc(tp elastictransport.Interface) NewMlDataFrameAnalytics
• 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 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/{branch}/cat-dfanalytics.html

func (*MlDataFrameAnalytics) AllowNoMatch

func (r *MlDataFrameAnalytics) AllowNoMatch(b 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(enum bytes.Bytes) *MlDataFrameAnalytics

Bytes The unit in which to display byte values API name: bytes

func (MlDataFrameAnalytics) Do

func (r MlDataFrameAnalytics) Do(ctx 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(v string) *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

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

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

func (*MlDataFrameAnalytics) Id

func (r *MlDataFrameAnalytics) Id(v string) *MlDataFrameAnalytics

Id The ID of the data frame analytics to fetch API Name: id

func (MlDataFrameAnalytics) IsSuccess

func (r MlDataFrameAnalytics) IsSuccess(ctx 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

func (r MlDataFrameAnalytics) Perform(ctx context.Context) (*http.Response, error)

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

func (*MlDataFrameAnalytics) S

func (r *MlDataFrameAnalytics) S(v string) *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(v 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

type Response []types.DataFrameAnalyticsRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response