updatedataframeanalytics

Documentation

Overview

Updates certain properties of a data frame analytics job.

Index

• Variables
• type NewUpdateDataFrameAnalytics
  • func NewUpdateDataFrameAnalyticsFunc(tp elastictransport.Interface) NewUpdateDataFrameAnalytics
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type UpdateDataFrameAnalytics
  • func New(tp elastictransport.Interface) *UpdateDataFrameAnalytics
  • func (r UpdateDataFrameAnalytics) Do(ctx context.Context) (*Response, error)
  • func (r *UpdateDataFrameAnalytics) Header(key, value string) *UpdateDataFrameAnalytics
  • func (r *UpdateDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateDataFrameAnalytics) Id(v string) *UpdateDataFrameAnalytics
  • func (r UpdateDataFrameAnalytics) Perform(ctx context.Context) (*http.Response, error)
  • func (r *UpdateDataFrameAnalytics) Raw(raw io.Reader) *UpdateDataFrameAnalytics
  • func (r *UpdateDataFrameAnalytics) Request(req *Request) *UpdateDataFrameAnalytics

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 NewUpdateDataFrameAnalytics

type NewUpdateDataFrameAnalytics func(id string) *UpdateDataFrameAnalytics

NewUpdateDataFrameAnalytics type alias for index.

func NewUpdateDataFrameAnalyticsFunc

func NewUpdateDataFrameAnalyticsFunc(tp elastictransport.Interface) NewUpdateDataFrameAnalytics

NewUpdateDataFrameAnalyticsFunc returns a new instance of UpdateDataFrameAnalytics 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"`
	// Description A description of the job.
	Description *string `json:"description,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"`
}

Request holds the request body struct for the package updatedataframeanalytics

https://github.com/elastic/elasticsearch-specification/blob/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/ml/update_data_frame_analytics/MlUpdateDataFrameAnalyticsRequest.ts#L24-L72

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 {
	AllowLazyStart   bool                                   `json:"allow_lazy_start"`
	Analysis         types.DataframeAnalysisContainer       `json:"analysis"`
	AnalyzedFields   *types.DataframeAnalysisAnalyzedFields `json:"analyzed_fields,omitempty"`
	Authorization    *types.DataframeAnalyticsAuthorization `json:"authorization,omitempty"`
	CreateTime       int64                                  `json:"create_time"`
	Description      *string                                `json:"description,omitempty"`
	Dest             types.DataframeAnalyticsDestination    `json:"dest"`
	Id               string                                 `json:"id"`
	MaxNumThreads    int                                    `json:"max_num_threads"`
	ModelMemoryLimit string                                 `json:"model_memory_limit"`
	Source           types.DataframeAnalyticsSource         `json:"source"`
	Version          string                                 `json:"version"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateDataFrameAnalytics

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

func New

func New(tp elastictransport.Interface) *UpdateDataFrameAnalytics

Updates certain properties of a data frame analytics job.

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

func (UpdateDataFrameAnalytics) Do

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

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

func (*UpdateDataFrameAnalytics) Header

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

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

func (*UpdateDataFrameAnalytics) HttpRequest

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

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

func (*UpdateDataFrameAnalytics) Id

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

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 (UpdateDataFrameAnalytics) Perform

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

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

func (*UpdateDataFrameAnalytics) Raw

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

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

func (*UpdateDataFrameAnalytics) Request

func (r *UpdateDataFrameAnalytics) Request(req *Request) *UpdateDataFrameAnalytics

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