deletetrainedmodel

Documentation

Overview

Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.

Index

• Variables
• type DeleteTrainedModel
  • func New(tp elastictransport.Interface) *DeleteTrainedModel
  • func (r DeleteTrainedModel) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteTrainedModel) Force(force bool) *DeleteTrainedModel
  • func (r *DeleteTrainedModel) Header(key, value string) *DeleteTrainedModel
  • func (r *DeleteTrainedModel) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteTrainedModel) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r DeleteTrainedModel) Perform(providedCtx context.Context) (*http.Response, error)
• type NewDeleteTrainedModel
  • func NewDeleteTrainedModelFunc(tp elastictransport.Interface) NewDeleteTrainedModel
• 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 DeleteTrainedModel

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

func New

func New(tp elastictransport.Interface) *DeleteTrainedModel

Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.

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

func (DeleteTrainedModel) Do

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

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

func (*DeleteTrainedModel) Force

func (r *DeleteTrainedModel) Force(force bool) *DeleteTrainedModel

Force Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. API name: force

func (*DeleteTrainedModel) Header

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

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

func (*DeleteTrainedModel) HttpRequest

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

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

func (DeleteTrainedModel) IsSuccess

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

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

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

type NewDeleteTrainedModel

type NewDeleteTrainedModel func(modelid string) *DeleteTrainedModel

NewDeleteTrainedModel type alias for index.

func NewDeleteTrainedModelFunc

func NewDeleteTrainedModelFunc(tp elastictransport.Interface) NewDeleteTrainedModel

NewDeleteTrainedModelFunc returns a new instance of DeleteTrainedModel 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 deletetrainedmodel

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ml/delete_trained_model/MlDeleteTrainedModelResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response