Documentation
¶
Overview ¶
Validate an anomaly detection job.
Index ¶
- Variables
- type NewValidate
- type Request
- type Response
- type Validate
- func (r *Validate) AnalysisConfig(analysisconfig types.AnalysisConfigVariant) *Validate
- func (r *Validate) AnalysisLimits(analysislimits types.AnalysisLimitsVariant) *Validate
- func (r *Validate) DataDescription(datadescription types.DataDescriptionVariant) *Validate
- func (r *Validate) Description(description string) *Validate
- func (r Validate) Do(providedCtx context.Context) (*Response, error)
- func (r *Validate) ErrorTrace(errortrace bool) *Validate
- func (r *Validate) FilterPath(filterpaths ...string) *Validate
- func (r *Validate) Header(key, value string) *Validate
- func (r *Validate) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Validate) Human(human bool) *Validate
- func (r *Validate) JobId(id string) *Validate
- func (r *Validate) ModelPlot(modelplot types.ModelPlotConfigVariant) *Validate
- func (r *Validate) ModelSnapshotId(id string) *Validate
- func (r *Validate) ModelSnapshotRetentionDays(modelsnapshotretentiondays int64) *Validate
- func (r Validate) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Validate) Pretty(pretty bool) *Validate
- func (r *Validate) Raw(raw io.Reader) *Validate
- func (r *Validate) Request(req *Request) *Validate
- func (r *Validate) ResultsIndexName(indexname string) *Validate
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 NewValidate ¶
type NewValidate func() *Validate
NewValidate type alias for index.
func NewValidateFunc ¶
func NewValidateFunc(tp elastictransport.Interface) NewValidate
NewValidateFunc returns a new instance of Validate with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
AnalysisConfig *types.AnalysisConfig `json:"analysis_config,omitempty"`
AnalysisLimits *types.AnalysisLimits `json:"analysis_limits,omitempty"`
DataDescription *types.DataDescription `json:"data_description,omitempty"`
Description *string `json:"description,omitempty"`
JobId *string `json:"job_id,omitempty"`
ModelPlot *types.ModelPlotConfig `json:"model_plot,omitempty"`
ModelSnapshotId *string `json:"model_snapshot_id,omitempty"`
ModelSnapshotRetentionDays *int64 `json:"model_snapshot_retention_days,omitempty"`
ResultsIndexName *string `json:"results_index_name,omitempty"`
}
Request holds the request body struct for the package validate
func (*Request) UnmarshalJSON ¶
type Response ¶
type Response struct {
// Acknowledged For a successful response, this value is always true. On failure, an
// exception is returned instead.
Acknowledged bool `json:"acknowledged"`
}
Response holds the response body struct for the package validate
type Validate ¶
type Validate struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Validate
Validate an anomaly detection job.
https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html
func (*Validate) AnalysisConfig ¶
func (r *Validate) AnalysisConfig(analysisconfig types.AnalysisConfigVariant) *Validate
API name: analysis_config
func (*Validate) AnalysisLimits ¶
func (r *Validate) AnalysisLimits(analysislimits types.AnalysisLimitsVariant) *Validate
API name: analysis_limits
func (*Validate) DataDescription ¶
func (r *Validate) DataDescription(datadescription types.DataDescriptionVariant) *Validate
API name: data_description
func (*Validate) Description ¶
API name: description
func (Validate) Do ¶
Do runs the request through the transport, handle the response and returns a validate.Response
func (*Validate) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*Validate) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*Validate) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Validate) Human ¶
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 (*Validate) ModelPlot ¶
func (r *Validate) ModelPlot(modelplot types.ModelPlotConfigVariant) *Validate
API name: model_plot
func (*Validate) ModelSnapshotId ¶
API name: model_snapshot_id
func (*Validate) ModelSnapshotRetentionDays ¶
API name: model_snapshot_retention_days
func (Validate) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Validate) Pretty ¶
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*Validate) Raw ¶
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*Validate) ResultsIndexName ¶
API name: results_index_name
Source Files