The highest tagged major version is
Documentation
¶
Overview ¶
Opens one or more anomaly detection jobs.
Index ¶
- Variables
- type NewOpenJob
- type OpenJob
- func (r OpenJob) Do(providedCtx context.Context) (*Response, error)
- func (r *OpenJob) ErrorTrace(errortrace bool) *OpenJob
- func (r *OpenJob) FilterPath(filterpaths ...string) *OpenJob
- func (r *OpenJob) Header(key, value string) *OpenJob
- func (r *OpenJob) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *OpenJob) Human(human bool) *OpenJob
- func (r OpenJob) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *OpenJob) Pretty(pretty bool) *OpenJob
- func (r *OpenJob) Raw(raw io.Reader) *OpenJob
- func (r *OpenJob) Request(req *Request) *OpenJob
- func (r *OpenJob) Timeout(duration types.Duration) *OpenJob
- 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 NewOpenJob ¶
NewOpenJob type alias for index.
func NewOpenJobFunc ¶
func NewOpenJobFunc(tp elastictransport.Interface) NewOpenJob
NewOpenJobFunc returns a new instance of OpenJob with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type OpenJob ¶
type OpenJob struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *OpenJob
Opens one or more anomaly detection jobs.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html
func (OpenJob) Do ¶
Do runs the request through the transport, handle the response and returns a openjob.Response
func (*OpenJob) 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 (*OpenJob) 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 (*OpenJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*OpenJob) 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 (OpenJob) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*OpenJob) 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 (*OpenJob) 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 Request ¶
type Request struct {
// 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 openjob
type Response ¶ added in v8.7.0
type Response struct {
// Node The ID of the node that the job was started on. In serverless this will be
// the "serverless".
// If the job is allowed to open lazily and has not yet been assigned to a node,
// this value is an empty string.
Node string `json:"node"`
Opened bool `json:"opened"`
}
Response holds the response body struct for the package openjob
Source Files