getdataframeanalyticsstats

Documentation

Overview

Get data frame analytics jobs usage info.

Index

• Variables
• type GetDataFrameAnalyticsStats
  • func New(tp elastictransport.Interface) *GetDataFrameAnalyticsStats
  • func (r *GetDataFrameAnalyticsStats) AllowNoMatch(allownomatch bool) *GetDataFrameAnalyticsStats
  • func (r GetDataFrameAnalyticsStats) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetDataFrameAnalyticsStats) ErrorTrace(errortrace bool) *GetDataFrameAnalyticsStats
  • func (r *GetDataFrameAnalyticsStats) FilterPath(filterpaths ...string) *GetDataFrameAnalyticsStats
  • func (r *GetDataFrameAnalyticsStats) From(from int) *GetDataFrameAnalyticsStats
  • func (r *GetDataFrameAnalyticsStats) Header(key, value string) *GetDataFrameAnalyticsStats
  • func (r *GetDataFrameAnalyticsStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetDataFrameAnalyticsStats) Human(human bool) *GetDataFrameAnalyticsStats
  • func (r *GetDataFrameAnalyticsStats) Id(id string) *GetDataFrameAnalyticsStats
  • func (r GetDataFrameAnalyticsStats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetDataFrameAnalyticsStats) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetDataFrameAnalyticsStats) Pretty(pretty bool) *GetDataFrameAnalyticsStats
  • func (r *GetDataFrameAnalyticsStats) Size(size int) *GetDataFrameAnalyticsStats
  • func (r *GetDataFrameAnalyticsStats) Verbose(verbose bool) *GetDataFrameAnalyticsStats
• type NewGetDataFrameAnalyticsStats
  • func NewGetDataFrameAnalyticsStatsFunc(tp elastictransport.Interface) NewGetDataFrameAnalyticsStats
• 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 GetDataFrameAnalyticsStats

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

func New

func New(tp elastictransport.Interface) *GetDataFrameAnalyticsStats

Get data frame analytics jobs usage info.

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

func (*GetDataFrameAnalyticsStats) AllowNoMatch

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

AllowNoMatch Specifies what to do when the request:

1. Contains wildcard expressions and there are no data frame analytics jobs 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 returns an empty data_frame_analytics 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 (GetDataFrameAnalyticsStats) Do

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

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

func (*GetDataFrameAnalyticsStats) ErrorTrace

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

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

func (*GetDataFrameAnalyticsStats) FilterPath

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

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

func (*GetDataFrameAnalyticsStats) From

func (r *GetDataFrameAnalyticsStats) From(from int) *GetDataFrameAnalyticsStats

From Skips the specified number of data frame analytics jobs. API name: from

func (*GetDataFrameAnalyticsStats) Header

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

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

func (*GetDataFrameAnalyticsStats) HttpRequest

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

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

func (*GetDataFrameAnalyticsStats) Human

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

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 (*GetDataFrameAnalyticsStats) Id

func (r *GetDataFrameAnalyticsStats) Id(id string) *GetDataFrameAnalyticsStats

Id Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs. API Name: id

func (GetDataFrameAnalyticsStats) IsSuccess

func (r GetDataFrameAnalyticsStats) 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 (GetDataFrameAnalyticsStats) Perform

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

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

func (*GetDataFrameAnalyticsStats) Pretty

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

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

func (*GetDataFrameAnalyticsStats) Size

func (r *GetDataFrameAnalyticsStats) Size(size int) *GetDataFrameAnalyticsStats

Size Specifies the maximum number of data frame analytics jobs to obtain. API name: size

func (*GetDataFrameAnalyticsStats) Verbose

func (r *GetDataFrameAnalyticsStats) Verbose(verbose bool) *GetDataFrameAnalyticsStats

Verbose Defines whether the stats response should be verbose. API name: verbose

type NewGetDataFrameAnalyticsStats

type NewGetDataFrameAnalyticsStats func() *GetDataFrameAnalyticsStats

NewGetDataFrameAnalyticsStats type alias for index.

func NewGetDataFrameAnalyticsStatsFunc

func NewGetDataFrameAnalyticsStatsFunc(tp elastictransport.Interface) NewGetDataFrameAnalyticsStats

NewGetDataFrameAnalyticsStatsFunc returns a new instance of GetDataFrameAnalyticsStats 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"`
	// DataFrameAnalytics An array of objects that contain usage information for data frame analytics
	// jobs, which are sorted by the id value in ascending order.
	DataFrameAnalytics []types.DataframeAnalytics `json:"data_frame_analytics"`
}

Response holds the response body struct for the package getdataframeanalyticsstats

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsResponse.ts#L23-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response