validate
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Validate an anomaly detection job.
Index¶
- Variables
- type NewValidate
- type Request
- type Response
- type Validate
- func (r *Validate) AnalysisConfig(analysisconfig *types.AnalysisConfig) *Validate
- func (r *Validate) AnalysisLimits(analysislimits *types.AnalysisLimits) *Validate
- func (r *Validate) DataDescription(datadescription *types.DataDescription) *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.ModelPlotConfig) *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¶
typeNewValidate¶
type NewValidate func() *Validate
NewValidate type alias for index.
funcNewValidateFunc¶
func NewValidateFunc(tpelastictransport.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.
typeRequest¶
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)FromJSON¶added inv8.5.0
FromJSON allows to load an arbitrary json into the request structure
func (*Request)UnmarshalJSON¶added inv8.12.1
typeResponse¶added inv8.7.0
type Response struct {// Acknowledged For a successful response, this value is always true. On failure, an// exception is returned instead.Acknowledgedbool `json:"acknowledged"`}Response holds the response body struct for the package validate
typeValidate¶
type Validate struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *Validate
Validate an anomaly detection job.
https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html
func (*Validate)AnalysisConfig¶added inv8.9.0
func (r *Validate) AnalysisConfig(analysisconfig *types.AnalysisConfig) *Validate
API name: analysis_config
func (*Validate)AnalysisLimits¶added inv8.9.0
func (r *Validate) AnalysisLimits(analysislimits *types.AnalysisLimits) *Validate
API name: analysis_limits
func (*Validate)DataDescription¶added inv8.9.0
func (r *Validate) DataDescription(datadescription *types.DataDescription) *Validate
API name: data_description
func (*Validate)Description¶added inv8.9.0
API name: description
func (Validate)Do¶
Do runs the request through the transport, handle the response and returns a validate.Response
func (*Validate)ErrorTrace¶added inv8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace
func (*Validate)FilterPath¶added inv8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path
func (*Validate)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*Validate)Human¶added inv8.14.0
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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human
func (*Validate)ModelPlot¶added inv8.9.0
func (r *Validate) ModelPlot(modelplot *types.ModelPlotConfig) *Validate
API name: model_plot
func (*Validate)ModelSnapshotId¶added inv8.9.0
API name: model_snapshot_id
func (*Validate)ModelSnapshotRetentionDays¶added inv8.9.0
API name: model_snapshot_retention_days
func (Validate)Perform¶added inv8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Validate)Pretty¶added inv8.14.0
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty
func (*Validate)Raw¶
Raw takes a json payload as input which is then passed to the http.RequestIf specified Raw takes precedence on Request method.
func (*Validate)ResultsIndexName¶added inv8.9.0
API name: results_index_name