deletetrainedmodelalias

Documentation

Overview

Delete a trained model alias. This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteTrainedModelAlias

Delete a trained model alias. This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error.

https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html

func (DeleteTrainedModelAlias) Do

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

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

func (*DeleteTrainedModelAlias) ErrorTrace

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

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

func (*DeleteTrainedModelAlias) FilterPath

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

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

func (*DeleteTrainedModelAlias) Header

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

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

func (*DeleteTrainedModelAlias) HttpRequest

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

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

func (*DeleteTrainedModelAlias) Human

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

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

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

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

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

func (*DeleteTrainedModelAlias) Pretty

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

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

type NewDeleteTrainedModelAlias

type NewDeleteTrainedModelAlias func(modelid, modelalias string) *DeleteTrainedModelAlias

NewDeleteTrainedModelAlias type alias for index.

func NewDeleteTrainedModelAliasFunc

func NewDeleteTrainedModelAliasFunc(tp elastictransport.Interface) NewDeleteTrainedModelAlias

NewDeleteTrainedModelAliasFunc returns a new instance of DeleteTrainedModelAlias 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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package deletetrainedmodelalias

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response