startdataframeanalytics

Documentation

Overview

Starts a data frame analytics job. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings.

Index

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

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 NewStartDataFrameAnalytics

type NewStartDataFrameAnalytics func(id string) *StartDataFrameAnalytics

NewStartDataFrameAnalytics type alias for index.

func NewStartDataFrameAnalyticsFunc

func NewStartDataFrameAnalyticsFunc(tp elastictransport.Interface) NewStartDataFrameAnalytics

NewStartDataFrameAnalyticsFunc returns a new instance of StartDataFrameAnalytics 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 {
	Acknowledged bool `json:"acknowledged"`
	// Node The ID of the node that the job was started on. If the job is allowed to open
	// lazily and has not yet been assigned to a node, this value is an empty
	// string.
	// The node ID of the node the job has been assigned to, or
	// an empty string if it hasn't been assigned to a node. In
	// serverless if the job has been assigned to run then the
	// node ID will be "serverless".
	Node string `json:"node"`
}

Response holds the response body struct for the package startdataframeanalytics

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/ml/start_data_frame_analytics/MlStartDataFrameAnalyticsResponse.ts#L22-L34

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type StartDataFrameAnalytics

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

func New

func New(tp elastictransport.Interface) *StartDataFrameAnalytics

Starts a data frame analytics job. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings.

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

func (StartDataFrameAnalytics) Do

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

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

func (*StartDataFrameAnalytics) ErrorTrace

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

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

func (*StartDataFrameAnalytics) FilterPath

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

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

func (*StartDataFrameAnalytics) Header

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

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

func (*StartDataFrameAnalytics) HttpRequest

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

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

func (*StartDataFrameAnalytics) Human

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

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

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

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

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

func (*StartDataFrameAnalytics) Pretty

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

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

func (*StartDataFrameAnalytics) Timeout

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

Timeout Controls the amount of time to wait until the data frame analytics job starts. API name: timeout