stoptrainedmodeldeployment

Documentation

Overview

Stops a trained model deployment.

Index

• Variables
• type NewStopTrainedModelDeployment
  • func NewStopTrainedModelDeploymentFunc(tp elastictransport.Interface) NewStopTrainedModelDeployment
• type Response
  • func NewResponse() *Response
• type StopTrainedModelDeployment
  • func New(tp elastictransport.Interface) *StopTrainedModelDeployment
  • func (r *StopTrainedModelDeployment) AllowNoMatch(allownomatch bool) *StopTrainedModelDeployment
  • func (r StopTrainedModelDeployment) Do(providedCtx context.Context) (*Response, error)
  • func (r *StopTrainedModelDeployment) ErrorTrace(errortrace bool) *StopTrainedModelDeployment
  • func (r *StopTrainedModelDeployment) FilterPath(filterpaths ...string) *StopTrainedModelDeployment
  • func (r *StopTrainedModelDeployment) Force(force bool) *StopTrainedModelDeployment
  • func (r *StopTrainedModelDeployment) Header(key, value string) *StopTrainedModelDeployment
  • func (r *StopTrainedModelDeployment) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *StopTrainedModelDeployment) Human(human bool) *StopTrainedModelDeployment
  • func (r StopTrainedModelDeployment) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r StopTrainedModelDeployment) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *StopTrainedModelDeployment) Pretty(pretty bool) *StopTrainedModelDeployment

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 NewStopTrainedModelDeployment

type NewStopTrainedModelDeployment func(modelid string) *StopTrainedModelDeployment

NewStopTrainedModelDeployment type alias for index.

func NewStopTrainedModelDeploymentFunc

func NewStopTrainedModelDeploymentFunc(tp elastictransport.Interface) NewStopTrainedModelDeployment

NewStopTrainedModelDeploymentFunc returns a new instance of StopTrainedModelDeployment 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 {
	Stopped bool `json:"stopped"`
}

Response holds the response body struct for the package stoptrainedmodeldeployment

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/ml/stop_trained_model_deployment/MlStopTrainedModelDeploymentResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type StopTrainedModelDeployment

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

func New

func New(tp elastictransport.Interface) *StopTrainedModelDeployment

Stops a trained model deployment.

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

func (*StopTrainedModelDeployment) AllowNoMatch

func (r *StopTrainedModelDeployment) AllowNoMatch(allownomatch bool) *StopTrainedModelDeployment

AllowNoMatch Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches. API name: allow_no_match

func (StopTrainedModelDeployment) Do

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

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

func (*StopTrainedModelDeployment) ErrorTrace

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

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

func (*StopTrainedModelDeployment) FilterPath

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

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

func (*StopTrainedModelDeployment) Force

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

Force Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you restart the model deployment. API name: force

func (*StopTrainedModelDeployment) Header

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

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

func (*StopTrainedModelDeployment) HttpRequest

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

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

func (*StopTrainedModelDeployment) Human

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

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

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

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

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

func (*StopTrainedModelDeployment) Pretty

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

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