Documentation
¶
Overview ¶
Predicts the future behavior of a time series by using its historical behavior.
Index ¶
- Variables
- type Forecast
- func (r Forecast) Do(providedCtx context.Context) (*Response, error)
- func (r *Forecast) Duration(duration types.Duration) *Forecast
- func (r *Forecast) ExpiresIn(duration types.Duration) *Forecast
- func (r *Forecast) Header(key, value string) *Forecast
- func (r *Forecast) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Forecast) MaxModelMemory(maxmodelmemory string) *Forecast
- func (r Forecast) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Forecast) Raw(raw io.Reader) *Forecast
- func (r *Forecast) Request(req *Request) *Forecast
- type NewForecast
- type Request
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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 ¶
Do runs the request through the transport, handle the response and returns a forecast.Response
func (*Forecast) Duration ¶
Duration Refer to the description for the `duration` query parameter. API name: duration
func (*Forecast) ExpiresIn ¶
ExpiresIn Refer to the description for the `expires_in` query parameter. API name: expires_in
func (*Forecast) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Forecast) MaxModelMemory ¶
MaxModelMemory Refer to the description for the `max_model_memory` query parameter. API name: max_model_memory
func (Forecast) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
type NewForecast ¶
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
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
Source Files