forecast

Documentation

Overview

Predicts the future behavior of a time series by using its historical behavior.

Index

• Variables
• type Forecast
  • func New(tp elastictransport.Interface) *Forecast
  • func (r Forecast) Do(ctx context.Context) (*Response, error)
  • func (r *Forecast) Duration(v string) *Forecast
  • func (r *Forecast) ExpiresIn(v string) *Forecast
  • func (r *Forecast) Header(key, value string) *Forecast
  • func (r *Forecast) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Forecast) JobId(v string) *Forecast
  • func (r *Forecast) MaxModelMemory(v string) *Forecast
  • func (r Forecast) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Forecast) Raw(raw io.Reader) *Forecast
  • func (r *Forecast) Request(req *Request) *Forecast
• type NewForecast
  • func NewForecastFunc(tp elastictransport.Interface) NewForecast
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response

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 Forecast

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

func New

func New(tp elastictransport.Interface) *Forecast

Predicts the future behavior of a time series by using its historical behavior.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html

func (Forecast) Do

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

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

func (*Forecast) Duration

func (r *Forecast) Duration(v string) *Forecast

Duration A period of time that indicates how far into the future to forecast. For example, `30d` corresponds to 30 days. The forecast starts at the last record that was processed. API name: duration

func (*Forecast) ExpiresIn

func (r *Forecast) ExpiresIn(v string) *Forecast

ExpiresIn The period of time that forecast results are retained. After a forecast expires, the results are deleted. If set to a value of 0, the forecast is never automatically deleted. API name: expires_in

func (*Forecast) Header

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

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

func (*Forecast) HttpRequest

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

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

func (*Forecast) JobId

func (r *Forecast) JobId(v string) *Forecast

JobId Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs. API Name: jobid

func (*Forecast) MaxModelMemory

func (r *Forecast) MaxModelMemory(v string) *Forecast

MaxModelMemory The maximum memory the forecast can use. If the forecast needs to use more than the provided amount, it will spool to disk. Default is 20mb, maximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s configured memory limit, it is automatically reduced to below that amount. API name: max_model_memory

func (Forecast) Perform

func (r Forecast) Perform(ctx context.Context) (*http.Response, error)

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

func (*Forecast) Raw

func (r *Forecast) Raw(raw io.Reader) *Forecast

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*Forecast) Request

func (r *Forecast) Request(req *Request) *Forecast

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

type NewForecast

type NewForecast func(jobid string) *Forecast

NewForecast type alias for index.

func NewForecastFunc

func NewForecastFunc(tp elastictransport.Interface) NewForecast

NewForecastFunc returns a new instance of Forecast 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 {

	// Duration Refer to the description for the `duration` query parameter.
	Duration types.Duration `json:"duration,omitempty"`
	// ExpiresIn Refer to the description for the `expires_in` query parameter.
	ExpiresIn types.Duration `json:"expires_in,omitempty"`
	// MaxModelMemory Refer to the description for the `max_model_memory` query parameter.
	MaxModelMemory *string `json:"max_model_memory,omitempty"`
}

Request holds the request body struct for the package forecast

https://github.com/elastic/elasticsearch-specification/blob/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/ml/forecast/MlForecastJobRequest.ts#L24-L87

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

type Response

type Response struct {
	Acknowledged bool   `json:"acknowledged"`
	ForecastId   string `json:"forecast_id"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response