cleartrainedmodeldeploymentcache

Documentation

Overview

Clear trained model deployment cache. Cache will be cleared on all nodes where the trained model is assigned. A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node. Calling this API clears the caches without restarting the deployment.

Index

• Variables
• type ClearTrainedModelDeploymentCache
  • func New(tp elastictransport.Interface) *ClearTrainedModelDeploymentCache
  • func (r ClearTrainedModelDeploymentCache) Do(providedCtx context.Context) (*Response, error)
  • func (r *ClearTrainedModelDeploymentCache) ErrorTrace(errortrace bool) *ClearTrainedModelDeploymentCache
  • func (r *ClearTrainedModelDeploymentCache) FilterPath(filterpaths ...string) *ClearTrainedModelDeploymentCache
  • func (r *ClearTrainedModelDeploymentCache) Header(key, value string) *ClearTrainedModelDeploymentCache
  • func (r *ClearTrainedModelDeploymentCache) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ClearTrainedModelDeploymentCache) Human(human bool) *ClearTrainedModelDeploymentCache
  • func (r ClearTrainedModelDeploymentCache) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ClearTrainedModelDeploymentCache) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ClearTrainedModelDeploymentCache) Pretty(pretty bool) *ClearTrainedModelDeploymentCache
• type NewClearTrainedModelDeploymentCache
  • func NewClearTrainedModelDeploymentCacheFunc(tp elastictransport.Interface) NewClearTrainedModelDeploymentCache
• 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 ClearTrainedModelDeploymentCache

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

func New

func New(tp elastictransport.Interface) *ClearTrainedModelDeploymentCache

Clear trained model deployment cache. Cache will be cleared on all nodes where the trained model is assigned. A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node. Calling this API clears the caches without restarting the deployment.

https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-trained-model-deployment-cache.html

func (ClearTrainedModelDeploymentCache) Do

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

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

func (*ClearTrainedModelDeploymentCache) ErrorTrace

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

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

func (*ClearTrainedModelDeploymentCache) FilterPath

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

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

func (*ClearTrainedModelDeploymentCache) Header

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

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

func (*ClearTrainedModelDeploymentCache) HttpRequest

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

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

func (*ClearTrainedModelDeploymentCache) Human

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

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

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

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

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

func (*ClearTrainedModelDeploymentCache) Pretty

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

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

type NewClearTrainedModelDeploymentCache

type NewClearTrainedModelDeploymentCache func(modelid string) *ClearTrainedModelDeploymentCache

NewClearTrainedModelDeploymentCache type alias for index.

func NewClearTrainedModelDeploymentCacheFunc

func NewClearTrainedModelDeploymentCacheFunc(tp elastictransport.Interface) NewClearTrainedModelDeploymentCache

NewClearTrainedModelDeploymentCacheFunc returns a new instance of ClearTrainedModelDeploymentCache 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 {
	Cleared bool `json:"cleared"`
}

Response holds the response body struct for the package cleartrainedmodeldeploymentcache

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheResponse.ts#L20-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response