stoptrainedmodeldeployment

Documentation

Overview

Stop 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(b bool) *StopTrainedModelDeployment
  • func (r StopTrainedModelDeployment) Do(ctx context.Context) (*Response, error)
  • func (r *StopTrainedModelDeployment) Force(b bool) *StopTrainedModelDeployment
  • func (r *StopTrainedModelDeployment) Header(key, value string) *StopTrainedModelDeployment
  • func (r *StopTrainedModelDeployment) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r StopTrainedModelDeployment) IsSuccess(ctx context.Context) (bool, error)
  • func (r *StopTrainedModelDeployment) ModelId(v string) *StopTrainedModelDeployment
  • func (r StopTrainedModelDeployment) Perform(ctx context.Context) (*http.Response, error)

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"`
}

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

Stop a trained model deployment.

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

func (*StopTrainedModelDeployment) AllowNoMatch

func (r *StopTrainedModelDeployment) AllowNoMatch(b 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(ctx context.Context) (*Response, error)

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

func (*StopTrainedModelDeployment) Force

func (r *StopTrainedModelDeployment) Force(b 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) IsSuccess

func (r StopTrainedModelDeployment) IsSuccess(ctx 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) ModelId

func (r *StopTrainedModelDeployment) ModelId(v string) *StopTrainedModelDeployment

ModelId The unique identifier of the trained model. API Name: modelid

func (StopTrainedModelDeployment) Perform

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

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