validate

Documentation

Overview

Validates an anomaly detection job.

Index

• Variables
• type NewValidate
  • func NewValidateFunc(tp elastictransport.Interface) NewValidate
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) AnalysisConfig(analysisconfig *types.AnalysisConfigBuilder) *RequestBuilder
  • func (rb *RequestBuilder) AnalysisLimits(analysislimits *types.AnalysisLimitsBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) DataDescription(datadescription *types.DataDescriptionBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Description(description string) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) JobId(jobid types.Id) *RequestBuilder
  • func (rb *RequestBuilder) ModelPlot(modelplot *types.ModelPlotConfigBuilder) *RequestBuilder
  • func (rb *RequestBuilder) ModelSnapshotId(modelsnapshotid types.Id) *RequestBuilder
  • func (rb *RequestBuilder) ModelSnapshotRetentionDays(modelsnapshotretentiondays int64) *RequestBuilder
  • func (rb *RequestBuilder) ResultsIndexName(resultsindexname types.IndexName) *RequestBuilder
• type Validate
  • func New(tp elastictransport.Interface) *Validate
  • func (r Validate) Do(ctx context.Context) (*http.Response, error)
  • func (r *Validate) Header(key, value string) *Validate
  • func (r *Validate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Validate) Raw(raw json.RawMessage) *Validate
  • func (r *Validate) Request(req *Request) *Validate

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 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 *types.Id `json:"job_id,omitempty"`

	ModelPlot *types.ModelPlotConfig `json:"model_plot,omitempty"`

	ModelSnapshotId *types.Id `json:"model_snapshot_id,omitempty"`

	ModelSnapshotRetentionDays *int64 `json:"model_snapshot_retention_days,omitempty"`

	ResultsIndexName *types.IndexName `json:"results_index_name,omitempty"`
}

Request holds the request body struct for the package validate

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/ml/validate/MlValidateJobRequest.ts#L27-L45

type RequestBuilder

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

RequestBuilder is the builder API for the validate.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) AnalysisConfig

func (rb *RequestBuilder) AnalysisConfig(analysisconfig *types.AnalysisConfigBuilder) *RequestBuilder

func (*RequestBuilder) AnalysisLimits

func (rb *RequestBuilder) AnalysisLimits(analysislimits *types.AnalysisLimitsBuilder) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) DataDescription

func (rb *RequestBuilder) DataDescription(datadescription *types.DataDescriptionBuilder) *RequestBuilder

func (*RequestBuilder) Description

func (rb *RequestBuilder) Description(description string) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) JobId

func (rb *RequestBuilder) JobId(jobid types.Id) *RequestBuilder

func (*RequestBuilder) ModelPlot

func (rb *RequestBuilder) ModelPlot(modelplot *types.ModelPlotConfigBuilder) *RequestBuilder

func (*RequestBuilder) ModelSnapshotId

func (rb *RequestBuilder) ModelSnapshotId(modelsnapshotid types.Id) *RequestBuilder

func (*RequestBuilder) ModelSnapshotRetentionDays

func (rb *RequestBuilder) ModelSnapshotRetentionDays(modelsnapshotretentiondays int64) *RequestBuilder

func (*RequestBuilder) ResultsIndexName

func (rb *RequestBuilder) ResultsIndexName(resultsindexname types.IndexName) *RequestBuilder

type Validate

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

func New

func New(tp elastictransport.Interface) *Validate

Validates an anomaly detection job.

https://www.elastic.co/guide/en/machine-learning/current/ml-jobs.html

func (Validate) Do

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

Do runs the http.Request through the provided transport.

func (*Validate) Header

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

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

func (*Validate) HttpRequest

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

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

func (*Validate) Raw

func (r *Validate) Raw(raw json.RawMessage) *Validate

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

func (r *Validate) Request(req *Request) *Validate

Request allows to set the request property with the appropriate payload.