getmodelsnapshotupgradestats

Documentation

Overview

Get anomaly detection job model snapshot upgrade usage info.

Index

• Variables
• type GetModelSnapshotUpgradeStats
  • func New(tp elastictransport.Interface) *GetModelSnapshotUpgradeStats
  • func (r *GetModelSnapshotUpgradeStats) AllowNoMatch(allownomatch bool) *GetModelSnapshotUpgradeStats
  • func (r GetModelSnapshotUpgradeStats) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetModelSnapshotUpgradeStats) ErrorTrace(errortrace bool) *GetModelSnapshotUpgradeStats
  • func (r *GetModelSnapshotUpgradeStats) FilterPath(filterpaths ...string) *GetModelSnapshotUpgradeStats
  • func (r *GetModelSnapshotUpgradeStats) Header(key, value string) *GetModelSnapshotUpgradeStats
  • func (r *GetModelSnapshotUpgradeStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetModelSnapshotUpgradeStats) Human(human bool) *GetModelSnapshotUpgradeStats
  • func (r GetModelSnapshotUpgradeStats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetModelSnapshotUpgradeStats) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetModelSnapshotUpgradeStats) Pretty(pretty bool) *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

Get anomaly detection job model snapshot upgrade usage info.

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

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

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

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

func (*GetModelSnapshotUpgradeStats) ErrorTrace

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

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

func (*GetModelSnapshotUpgradeStats) FilterPath

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

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

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) Human

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

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 (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

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

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

func (*GetModelSnapshotUpgradeStats) Pretty

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

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

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

Response holds the response body struct for the package getmodelsnapshotupgradestats

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response