validate

Documentation

Overview

Validates an anomaly detection job.

Index

• Variables
• type NewValidate
  • func NewValidateFunc(tp elastictransport.Interface) NewValidate
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response
• type Validate
  • func New(tp elastictransport.Interface) *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) Header(key, value string) *Validate
  • func (r *Validate) HttpRequest(ctx context.Context) (*http.Request, error)
  • 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) Raw(raw io.Reader) *Validate
  • func (r *Validate) Request(req *Request) *Validate
  • func (r *Validate) ResultsIndexName(indexname string) *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                      *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

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ml/validate/MlValidateJobRequest.ts#L27-L44

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

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

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ml/validate/MlValidateJobResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

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

func (r *Validate) AnalysisConfig(analysisconfig *types.AnalysisConfig) *Validate

API name: analysis_config

func (*Validate) AnalysisLimits

func (r *Validate) AnalysisLimits(analysislimits *types.AnalysisLimits) *Validate

API name: analysis_limits

func (*Validate) DataDescription

func (r *Validate) DataDescription(datadescription *types.DataDescription) *Validate

API name: data_description

func (*Validate) Description

func (r *Validate) Description(description string) *Validate

API name: description

func (Validate) Do

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

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

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

func (r *Validate) JobId(id string) *Validate

API name: job_id

func (*Validate) ModelPlot

func (r *Validate) ModelPlot(modelplot *types.ModelPlotConfig) *Validate

API name: model_plot

func (*Validate) ModelSnapshotId

func (r *Validate) ModelSnapshotId(id string) *Validate

API name: model_snapshot_id

func (*Validate) ModelSnapshotRetentionDays

func (r *Validate) ModelSnapshotRetentionDays(modelsnapshotretentiondays int64) *Validate

API name: model_snapshot_retention_days

func (Validate) Perform

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

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

func (*Validate) Raw

func (r *Validate) Raw(raw io.Reader) *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.

func (*Validate) ResultsIndexName

func (r *Validate) ResultsIndexName(indexname string) *Validate

API name: results_index_name