stopdataframeanalytics

Documentation

Overview

Stop data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle.

Index

• Variables
• type NewStopDataFrameAnalytics
  • func NewStopDataFrameAnalyticsFunc(tp elastictransport.Interface) NewStopDataFrameAnalytics
• type Response
  • func NewResponse() *Response
• type StopDataFrameAnalytics
  • func New(tp elastictransport.Interface) *StopDataFrameAnalytics
  • func (r *StopDataFrameAnalytics) AllowNoMatch(allownomatch bool) *StopDataFrameAnalytics
  • func (r StopDataFrameAnalytics) Do(providedCtx context.Context) (*Response, error)
  • func (r *StopDataFrameAnalytics) ErrorTrace(errortrace bool) *StopDataFrameAnalytics
  • func (r *StopDataFrameAnalytics) FilterPath(filterpaths ...string) *StopDataFrameAnalytics
  • func (r *StopDataFrameAnalytics) Force(force bool) *StopDataFrameAnalytics
  • func (r *StopDataFrameAnalytics) Header(key, value string) *StopDataFrameAnalytics
  • func (r *StopDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *StopDataFrameAnalytics) Human(human bool) *StopDataFrameAnalytics
  • func (r StopDataFrameAnalytics) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r StopDataFrameAnalytics) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *StopDataFrameAnalytics) Pretty(pretty bool) *StopDataFrameAnalytics
  • func (r *StopDataFrameAnalytics) Timeout(duration string) *StopDataFrameAnalytics

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 NewStopDataFrameAnalytics

type NewStopDataFrameAnalytics func(id string) *StopDataFrameAnalytics

NewStopDataFrameAnalytics type alias for index.

func NewStopDataFrameAnalyticsFunc

func NewStopDataFrameAnalyticsFunc(tp elastictransport.Interface) NewStopDataFrameAnalytics

NewStopDataFrameAnalyticsFunc returns a new instance of StopDataFrameAnalytics 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 {
	Stopped bool `json:"stopped"`
}

Response holds the response body struct for the package stopdataframeanalytics

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/ml/stop_data_frame_analytics/MlStopDataFrameAnalyticsResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type StopDataFrameAnalytics

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

func New

func New(tp elastictransport.Interface) *StopDataFrameAnalytics

Stop data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-data-frame-analytics

func (*StopDataFrameAnalytics) AllowNoMatch

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

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 is true, which 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 (StopDataFrameAnalytics) Do

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

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

func (*StopDataFrameAnalytics) ErrorTrace

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

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

func (*StopDataFrameAnalytics) FilterPath

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

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

func (*StopDataFrameAnalytics) Force

func (r *StopDataFrameAnalytics) Force(force bool) *StopDataFrameAnalytics

Force If true, the data frame analytics job is stopped forcefully. API name: force

func (*StopDataFrameAnalytics) Header

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

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

func (*StopDataFrameAnalytics) HttpRequest

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

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

func (*StopDataFrameAnalytics) Human

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

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 (StopDataFrameAnalytics) IsSuccess

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

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

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

func (*StopDataFrameAnalytics) Pretty

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

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

func (*StopDataFrameAnalytics) Timeout

func (r *StopDataFrameAnalytics) Timeout(duration string) *StopDataFrameAnalytics

Timeout Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds. API name: timeout