getmodelsnapshotupgradestats

package
v8.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2024 License: Apache-2.0 Imports: 12 Imported by: 3

Documentation

Overview

Gets stats for anomaly detection job model snapshot upgrades that are in progress.

Index

Constants

This section is empty.

Variables

View Source
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 GetModelSnapshotUpgradeStats

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

func (*GetModelSnapshotUpgradeStats) AllowNoMatch

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

AllowNoMatch Specifies what to do when the request:

  • Contains wildcard expressions and there are no jobs that match.
  • Contains the _all string or no identifiers and there are no matches.
  • Contains wildcard expressions and there are only partial matches.

The default value is true, which returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. API name: allow_no_match

func (GetModelSnapshotUpgradeStats) Do

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

func (*GetModelSnapshotUpgradeStats) Header

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

func (*GetModelSnapshotUpgradeStats) HttpRequest

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

func (GetModelSnapshotUpgradeStats) IsSuccess

func (r GetModelSnapshotUpgradeStats) 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 (GetModelSnapshotUpgradeStats) Perform added in v8.7.0

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

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

type NewGetModelSnapshotUpgradeStats

type NewGetModelSnapshotUpgradeStats func(jobid, snapshotid string) *GetModelSnapshotUpgradeStats

NewGetModelSnapshotUpgradeStats type alias for index.

func NewGetModelSnapshotUpgradeStatsFunc

func NewGetModelSnapshotUpgradeStatsFunc(tp elastictransport.Interface) NewGetModelSnapshotUpgradeStats

NewGetModelSnapshotUpgradeStatsFunc returns a new instance of GetModelSnapshotUpgradeStats 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 {
	Count                 int64                        `json:"count"`
	ModelSnapshotUpgrades []types.ModelSnapshotUpgrade `json:"model_snapshot_upgrades"`
}

Response holds the response body struct for the package getmodelsnapshotupgradestats

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsResponse.ts#L23-L28

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL