previewdataframeanalytics

Documentation

Overview

Preview features used by data frame analytics. Previews the extracted features used by a data frame analytics config.

Index

• Variables
• type NewPreviewDataFrameAnalytics
  • func NewPreviewDataFrameAnalyticsFunc(tp elastictransport.Interface) NewPreviewDataFrameAnalytics
• type PreviewDataFrameAnalytics
  • func New(tp elastictransport.Interface) *PreviewDataFrameAnalytics
  • func (r *PreviewDataFrameAnalytics) Config(config *types.DataframePreviewConfig) *PreviewDataFrameAnalytics
  • func (r PreviewDataFrameAnalytics) Do(providedCtx context.Context) (*Response, error)
  • func (r *PreviewDataFrameAnalytics) ErrorTrace(errortrace bool) *PreviewDataFrameAnalytics
  • func (r *PreviewDataFrameAnalytics) FilterPath(filterpaths ...string) *PreviewDataFrameAnalytics
  • func (r *PreviewDataFrameAnalytics) Header(key, value string) *PreviewDataFrameAnalytics
  • func (r *PreviewDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PreviewDataFrameAnalytics) Human(human bool) *PreviewDataFrameAnalytics
  • func (r *PreviewDataFrameAnalytics) Id(id string) *PreviewDataFrameAnalytics
  • func (r PreviewDataFrameAnalytics) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PreviewDataFrameAnalytics) Pretty(pretty bool) *PreviewDataFrameAnalytics
  • func (r *PreviewDataFrameAnalytics) Raw(raw io.Reader) *PreviewDataFrameAnalytics
  • func (r *PreviewDataFrameAnalytics) Request(req *Request) *PreviewDataFrameAnalytics
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• 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 NewPreviewDataFrameAnalytics

type NewPreviewDataFrameAnalytics func() *PreviewDataFrameAnalytics

NewPreviewDataFrameAnalytics type alias for index.

func NewPreviewDataFrameAnalyticsFunc

func NewPreviewDataFrameAnalyticsFunc(tp elastictransport.Interface) NewPreviewDataFrameAnalytics

NewPreviewDataFrameAnalyticsFunc returns a new instance of PreviewDataFrameAnalytics with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PreviewDataFrameAnalytics

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

func New

func New(tp elastictransport.Interface) *PreviewDataFrameAnalytics

Preview features used by data frame analytics. Previews the extracted features used by a data frame analytics config.

http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html

func (*PreviewDataFrameAnalytics) Config

func (r *PreviewDataFrameAnalytics) Config(config *types.DataframePreviewConfig) *PreviewDataFrameAnalytics

Config A data frame analytics config as described in create data frame analytics jobs. Note that `id` and `dest` don’t need to be provided in the context of this API. API name: config

func (PreviewDataFrameAnalytics) Do

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

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

func (*PreviewDataFrameAnalytics) ErrorTrace

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

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

func (*PreviewDataFrameAnalytics) FilterPath

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

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

func (*PreviewDataFrameAnalytics) Header

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

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

func (*PreviewDataFrameAnalytics) HttpRequest

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

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

func (*PreviewDataFrameAnalytics) Human

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

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

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

Id Identifier for the data frame analytics job. API Name: id

func (PreviewDataFrameAnalytics) Perform

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

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

func (*PreviewDataFrameAnalytics) Pretty

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

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

func (*PreviewDataFrameAnalytics) Raw

func (r *PreviewDataFrameAnalytics) Raw(raw io.Reader) *PreviewDataFrameAnalytics

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*PreviewDataFrameAnalytics) Request

func (r *PreviewDataFrameAnalytics) Request(req *Request) *PreviewDataFrameAnalytics

Request allows to set the request property with the appropriate payload.

type Request

type Request struct {

	// Config A data frame analytics config as described in create data frame analytics
	// jobs. Note that `id` and `dest` don’t need to be provided in the context of
	// this API.
	Config *types.DataframePreviewConfig `json:"config,omitempty"`
}

Request holds the request body struct for the package previewdataframeanalytics

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts#L24-L49

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {

	// FeatureValues An array of objects that contain feature name and value pairs. The features
	// have been processed and indicate what will be sent to the model for training.
	FeatureValues []map[string]string `json:"feature_values"`
}

Response holds the response body struct for the package previewdataframeanalytics

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response