explaindataframeanalytics

Documentation

Overview

Explains a data frame analytics config.

Index

• Variables
• type ExplainDataFrameAnalytics
  • func New(tp elastictransport.Interface) *ExplainDataFrameAnalytics
  • func (r ExplainDataFrameAnalytics) Do(ctx context.Context) (*Response, error)
  • func (r *ExplainDataFrameAnalytics) Header(key, value string) *ExplainDataFrameAnalytics
  • func (r *ExplainDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ExplainDataFrameAnalytics) Id(v string) *ExplainDataFrameAnalytics
  • func (r ExplainDataFrameAnalytics) Perform(ctx context.Context) (*http.Response, error)
  • func (r *ExplainDataFrameAnalytics) Raw(raw io.Reader) *ExplainDataFrameAnalytics
  • func (r *ExplainDataFrameAnalytics) Request(req *Request) *ExplainDataFrameAnalytics
• type NewExplainDataFrameAnalytics
  • func NewExplainDataFrameAnalyticsFunc(tp elastictransport.Interface) NewExplainDataFrameAnalytics
• 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 ExplainDataFrameAnalytics

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

func New

func New(tp elastictransport.Interface) *ExplainDataFrameAnalytics

Explains a data frame analytics config.

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

func (ExplainDataFrameAnalytics) Do

func (r ExplainDataFrameAnalytics) Do(ctx context.Context) (*Response, error)

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

func (*ExplainDataFrameAnalytics) Header

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

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

func (*ExplainDataFrameAnalytics) HttpRequest

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

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

func (*ExplainDataFrameAnalytics) Id

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

Id Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. API Name: id

func (ExplainDataFrameAnalytics) Perform

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

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

func (*ExplainDataFrameAnalytics) Raw

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

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

func (*ExplainDataFrameAnalytics) Request

func (r *ExplainDataFrameAnalytics) Request(req *Request) *ExplainDataFrameAnalytics

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

type NewExplainDataFrameAnalytics

type NewExplainDataFrameAnalytics func() *ExplainDataFrameAnalytics

NewExplainDataFrameAnalytics type alias for index.

func NewExplainDataFrameAnalyticsFunc

func NewExplainDataFrameAnalyticsFunc(tp elastictransport.Interface) NewExplainDataFrameAnalytics

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

type Request

type Request struct {

	// AllowLazyStart Specifies whether this job can start when there is insufficient machine
	// learning node capacity for it to be immediately assigned to a node.
	AllowLazyStart *bool `json:"allow_lazy_start,omitempty"`
	// Analysis The analysis configuration, which contains the information necessary to
	// perform one of the following types of analysis: classification, outlier
	// detection, or regression.
	Analysis *types.DataframeAnalysisContainer `json:"analysis,omitempty"`
	// AnalyzedFields Specify includes and/or excludes patterns to select which fields will be
	// included in the analysis. The patterns specified in excludes are applied
	// last, therefore excludes takes precedence. In other words, if the same
	// field is specified in both includes and excludes, then the field will not
	// be included in the analysis.
	AnalyzedFields *types.DataframeAnalysisAnalyzedFields `json:"analyzed_fields,omitempty"`
	// Description A description of the job.
	Description *string `json:"description,omitempty"`
	// Dest The destination configuration, consisting of index and optionally
	// results_field (ml by default).
	Dest *types.DataframeAnalyticsDestination `json:"dest,omitempty"`
	// MaxNumThreads The maximum number of threads to be used by the analysis. Using more
	// threads may decrease the time necessary to complete the analysis at the
	// cost of using more CPU. Note that the process may use additional threads
	// for operational functionality other than the analysis itself.
	MaxNumThreads *int `json:"max_num_threads,omitempty"`
	// ModelMemoryLimit The approximate maximum amount of memory resources that are permitted for
	// analytical processing. If your `elasticsearch.yml` file contains an
	// `xpack.ml.max_model_memory_limit` setting, an error occurs when you try to
	// create data frame analytics jobs that have `model_memory_limit` values
	// greater than that setting.
	ModelMemoryLimit *string `json:"model_memory_limit,omitempty"`
	// Source The configuration of how to source the analysis data. It requires an
	// index. Optionally, query and _source may be specified.
	Source *types.DataframeAnalyticsSource `json:"source,omitempty"`
}

Request holds the request body struct for the package explaindataframeanalytics

https://github.com/elastic/elasticsearch-specification/blob/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts#L30-L107

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 {

	// FieldSelection An array of objects that explain selection for each field, sorted by the
	// field names.
	FieldSelection []types.DataframeAnalyticsFieldSelection `json:"field_selection"`
	// MemoryEstimation An array of objects that explain selection for each field, sorted by the
	// field names.
	MemoryEstimation types.DataframeAnalyticsMemoryEstimation `json:"memory_estimation"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response