validate

package
v8.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 12 Imported by: 3

Documentation

Overview

Validates an anomaly detection job.

Index

Constants

This section is empty.

Variables

View Source 
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

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

func NewRequest added in v8.5.0 

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0 

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

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON added in v8.12.1 

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

type Response added in v8.7.0 

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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/ml/validate/MlValidateJobResponse.ts#L22-L24

func NewResponse added in v8.7.0 

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 added in v8.9.0 

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

API name: analysis_config

func (*Validate) AnalysisLimits added in v8.9.0 

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

API name: analysis_limits

func (*Validate) DataDescription added in v8.9.0 

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

API name: data_description

func (*Validate) Description added in v8.9.0 

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 added in v8.9.0 

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

API name: job_id

func (*Validate) ModelPlot added in v8.9.0 

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

API name: model_plot

func (*Validate) ModelSnapshotId added in v8.9.0 

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

API name: model_snapshot_id

func (*Validate) ModelSnapshotRetentionDays added in v8.9.0 

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

API name: model_snapshot_retention_days

func (Validate) Perform added in v8.7.0 

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 added in v8.9.0 

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

API name: results_index_name

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.