forecast

Documentation

Overview

Predict future behavior of a time series.

Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an `over_field_name` in its configuration. Forcasts predict future behavior based on historical data.

Index

• Variables
• type Forecast
  • func New(tp elastictransport.Interface) *Forecast
  • func (r Forecast) Do(providedCtx context.Context) (*Response, error)
  • func (r *Forecast) Duration(duration types.Duration) *Forecast
  • func (r *Forecast) ErrorTrace(errortrace bool) *Forecast
  • func (r *Forecast) ExpiresIn(duration types.Duration) *Forecast
  • func (r *Forecast) FilterPath(filterpaths ...string) *Forecast
  • func (r *Forecast) Header(key, value string) *Forecast
  • func (r *Forecast) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Forecast) Human(human bool) *Forecast
  • func (r *Forecast) MaxModelMemory(maxmodelmemory string) *Forecast
  • func (r Forecast) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Forecast) Pretty(pretty bool) *Forecast
  • 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)
  • func (s *Request) UnmarshalJSON(data []byte) 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

Predict future behavior of a time series.

Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an `over_field_name` in its configuration. Forcasts predict future behavior based on historical data.

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

func (Forecast) Do

func (r Forecast) Do(providedCtx 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(duration types.Duration) *Forecast

Duration Refer to the description for the `duration` query parameter. API name: duration

func (*Forecast) ErrorTrace

func (r *Forecast) ErrorTrace(errortrace bool) *Forecast

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Forecast) ExpiresIn

func (r *Forecast) ExpiresIn(duration types.Duration) *Forecast

ExpiresIn Refer to the description for the `expires_in` query parameter. API name: expires_in

func (*Forecast) FilterPath

func (r *Forecast) FilterPath(filterpaths ...string) *Forecast

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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

func (r *Forecast) Human(human bool) *Forecast

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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*Forecast) MaxModelMemory

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

MaxModelMemory Refer to the description for the `max_model_memory` query parameter. API name: max_model_memory

func (Forecast) Perform

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

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

func (*Forecast) Pretty

func (r *Forecast) Pretty(pretty bool) *Forecast

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/forecast/MlForecastJobRequest.ts#L24-L88

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 bool   `json:"acknowledged"`
	ForecastId   string `json:"forecast_id"`
}

Response holds the response body struct for the package forecast

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ml/forecast/MlForecastJobResponse.ts#L22-L27

func NewResponse

func NewResponse() *Response

NewResponse returns a Response