Documentation
¶
Overview ¶
Stop a trained model deployment.
Index ¶
- Variables
- type NewStopTrainedModelDeployment
- type Response
- type StopTrainedModelDeployment
- func (r *StopTrainedModelDeployment) AllowNoMatch(allownomatch bool) *StopTrainedModelDeployment
- func (r StopTrainedModelDeployment) Do(providedCtx context.Context) (*Response, error)
- 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) IsSuccess(providedCtx context.Context) (bool, error)
- func (r StopTrainedModelDeployment) Perform(providedCtx context.Context) (*http.Response, error)
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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 ¶ added in v8.7.0
type Response struct {
Stopped bool `json:"stopped"`
}
Response holds the response body struct for the package stoptrainedmodeldeployment
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/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) 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 ¶
HttpRequest returns the http.Request object built from the given parameters.
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.
Source Files