getmodelsnapshotupgradestats

Documentation

Overview

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

Index

• Variables
• type GetModelSnapshotUpgradeStats
  • func New(tp elastictransport.Interface) *GetModelSnapshotUpgradeStats
  • func (r *GetModelSnapshotUpgradeStats) AllowNoMatch(b bool) *GetModelSnapshotUpgradeStats
  • func (r GetModelSnapshotUpgradeStats) Do(ctx context.Context) (*Response, error)
  • func (r *GetModelSnapshotUpgradeStats) Header(key, value string) *GetModelSnapshotUpgradeStats
  • func (r *GetModelSnapshotUpgradeStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetModelSnapshotUpgradeStats) IsSuccess(ctx context.Context) (bool, error)
  • func (r *GetModelSnapshotUpgradeStats) JobId(v string) *GetModelSnapshotUpgradeStats
  • func (r GetModelSnapshotUpgradeStats) Perform(ctx context.Context) (*http.Response, error)
  • func (r *GetModelSnapshotUpgradeStats) SnapshotId(v string) *GetModelSnapshotUpgradeStats
• type NewGetModelSnapshotUpgradeStats
  • func NewGetModelSnapshotUpgradeStatsFunc(tp elastictransport.Interface) NewGetModelSnapshotUpgradeStats
• 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 GetModelSnapshotUpgradeStats

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

func New

func New(tp elastictransport.Interface) *GetModelSnapshotUpgradeStats

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

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html

func (*GetModelSnapshotUpgradeStats) AllowNoMatch

func (r *GetModelSnapshotUpgradeStats) AllowNoMatch(b 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

func (r GetModelSnapshotUpgradeStats) Do(ctx context.Context) (*Response, error)

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

func (*GetModelSnapshotUpgradeStats) Header

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

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

func (*GetModelSnapshotUpgradeStats) HttpRequest

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

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

func (GetModelSnapshotUpgradeStats) IsSuccess

func (r GetModelSnapshotUpgradeStats) 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 (*GetModelSnapshotUpgradeStats) JobId

func (r *GetModelSnapshotUpgradeStats) JobId(v string) *GetModelSnapshotUpgradeStats

JobId Identifier for the anomaly detection job. API Name: jobid

func (GetModelSnapshotUpgradeStats) Perform

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

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

func (*GetModelSnapshotUpgradeStats) SnapshotId

func (r *GetModelSnapshotUpgradeStats) SnapshotId(v string) *GetModelSnapshotUpgradeStats

SnapshotId A numerical character string that uniquely identifies the model snapshot. You can get information for multiple snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`, by specifying `*` as the snapshot ID, or by omitting the snapshot ID. API Name: snapshotid

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

type Response struct {
	Count                 int64                        `json:"count"`
	ModelSnapshotUpgrades []types.ModelSnapshotUpgrade `json:"model_snapshot_upgrades"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response