Documentation
¶
Overview ¶
Close anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job.
Index ¶
- Variables
- type CloseJob
- func (r *CloseJob) AllowNoMatch(allownomatch bool) *CloseJob
- func (r CloseJob) Do(providedCtx context.Context) (*Response, error)
- func (r *CloseJob) ErrorTrace(errortrace bool) *CloseJob
- func (r *CloseJob) FilterPath(filterpaths ...string) *CloseJob
- func (r *CloseJob) Force(force bool) *CloseJob
- func (r *CloseJob) Header(key, value string) *CloseJob
- func (r *CloseJob) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *CloseJob) Human(human bool) *CloseJob
- func (r CloseJob) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *CloseJob) Pretty(pretty bool) *CloseJob
- func (r *CloseJob) Raw(raw io.Reader) *CloseJob
- func (r *CloseJob) Request(req *Request) *CloseJob
- func (r *CloseJob) Timeout(duration types.Duration) *CloseJob
- type NewCloseJob
- 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 CloseJob ¶
type CloseJob struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *CloseJob
Close anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html
func (*CloseJob) AllowNoMatch ¶
AllowNoMatch Refer to the description for the `allow_no_match` query parameter. API name: allow_no_match
func (CloseJob) Do ¶
Do runs the request through the transport, handle the response and returns a closejob.Response
func (*CloseJob) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*CloseJob) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*CloseJob) Force ¶
Force Refer to the descriptiion for the `force` query parameter. API name: force
func (*CloseJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*CloseJob) Human ¶ added in v8.14.0
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 (CloseJob) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*CloseJob) Pretty ¶ added in v8.14.0
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*CloseJob) Raw ¶
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
type NewCloseJob ¶
NewCloseJob type alias for index.
func NewCloseJobFunc ¶
func NewCloseJobFunc(tp elastictransport.Interface) NewCloseJob
NewCloseJobFunc returns a new instance of CloseJob 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 {
// AllowNoMatch Refer to the description for the `allow_no_match` query parameter.
AllowNoMatch *bool `json:"allow_no_match,omitempty"`
// Force Refer to the descriptiion for the `force` query parameter.
Force *bool `json:"force,omitempty"`
// Timeout Refer to the description for the `timeout` query parameter.
Timeout types.Duration `json:"timeout,omitempty"`
}
Request holds the request body struct for the package closejob
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
Source Files