estimatemodelmemory

Documentation

Overview

Estimates the model memory

Index

• Variables
• type EstimateModelMemory
  • func New(tp elastictransport.Interface) *EstimateModelMemory
  • func (r *EstimateModelMemory) AnalysisConfig(analysisconfig *types.AnalysisConfig) *EstimateModelMemory
  • func (r EstimateModelMemory) Do(providedCtx context.Context) (*Response, error)
  • func (r *EstimateModelMemory) Header(key, value string) *EstimateModelMemory
  • func (r *EstimateModelMemory) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *EstimateModelMemory) MaxBucketCardinality(maxbucketcardinality map[string]int64) *EstimateModelMemory
  • func (r *EstimateModelMemory) OverallCardinality(overallcardinality map[string]int64) *EstimateModelMemory
  • func (r EstimateModelMemory) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *EstimateModelMemory) Raw(raw io.Reader) *EstimateModelMemory
  • func (r *EstimateModelMemory) Request(req *Request) *EstimateModelMemory
• type NewEstimateModelMemory
  • func NewEstimateModelMemoryFunc(tp elastictransport.Interface) NewEstimateModelMemory
• 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 EstimateModelMemory

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

func New

func New(tp elastictransport.Interface) *EstimateModelMemory

Estimates the model memory

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html

func (*EstimateModelMemory) AnalysisConfig

func (r *EstimateModelMemory) AnalysisConfig(analysisconfig *types.AnalysisConfig) *EstimateModelMemory

AnalysisConfig For a list of the properties that you can specify in the `analysis_config` component of the body of this API. API name: analysis_config

func (EstimateModelMemory) Do

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

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

func (*EstimateModelMemory) Header

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

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

func (*EstimateModelMemory) HttpRequest

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

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

func (*EstimateModelMemory) MaxBucketCardinality

func (r *EstimateModelMemory) MaxBucketCardinality(maxbucketcardinality map[string]int64) *EstimateModelMemory

MaxBucketCardinality Estimates of the highest cardinality in a single bucket that is observed for influencer fields over the time period that the job analyzes data. To produce a good answer, values must be provided for all influencer fields. Providing values for fields that are not listed as `influencers` has no effect on the estimation. API name: max_bucket_cardinality

func (*EstimateModelMemory) OverallCardinality

func (r *EstimateModelMemory) OverallCardinality(overallcardinality map[string]int64) *EstimateModelMemory

OverallCardinality Estimates of the cardinality that is observed for fields over the whole time period that the job analyzes data. To produce a good answer, values must be provided for fields referenced in the `by_field_name`, `over_field_name` and `partition_field_name` of any detectors. Providing values for other fields has no effect on the estimation. It can be omitted from the request if no detectors have a `by_field_name`, `over_field_name` or `partition_field_name`. API name: overall_cardinality

func (EstimateModelMemory) Perform

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

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

func (*EstimateModelMemory) Raw

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

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

func (*EstimateModelMemory) Request

func (r *EstimateModelMemory) Request(req *Request) *EstimateModelMemory

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

type NewEstimateModelMemory

type NewEstimateModelMemory func() *EstimateModelMemory

NewEstimateModelMemory type alias for index.

func NewEstimateModelMemoryFunc

func NewEstimateModelMemoryFunc(tp elastictransport.Interface) NewEstimateModelMemory

NewEstimateModelMemoryFunc returns a new instance of EstimateModelMemory 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 {

	// AnalysisConfig For a list of the properties that you can specify in the
	// `analysis_config` component of the body of this API.
	AnalysisConfig *types.AnalysisConfig `json:"analysis_config,omitempty"`
	// MaxBucketCardinality Estimates of the highest cardinality in a single bucket that is observed
	// for influencer fields over the time period that the job analyzes data.
	// To produce a good answer, values must be provided for all influencer
	// fields. Providing values for fields that are not listed as `influencers`
	// has no effect on the estimation.
	MaxBucketCardinality map[string]int64 `json:"max_bucket_cardinality,omitempty"`
	// OverallCardinality Estimates of the cardinality that is observed for fields over the whole
	// time period that the job analyzes data. To produce a good answer, values
	// must be provided for fields referenced in the `by_field_name`,
	// `over_field_name` and `partition_field_name` of any detectors. Providing
	// values for other fields has no effect on the estimation. It can be
	// omitted from the request if no detectors have a `by_field_name`,
	// `over_field_name` or `partition_field_name`.
	OverallCardinality map[string]int64 `json:"overall_cardinality,omitempty"`
}

Request holds the request body struct for the package estimatemodelmemory

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L61

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 {
	ModelMemoryEstimate string `json:"model_memory_estimate"`
}

Response holds the response body struct for the package estimatemodelmemory

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ml/estimate_model_memory/MlEstimateModelMemoryResponse.ts#L20-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response