Documentation
¶
Overview ¶
Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
Index ¶
- Variables
- type GetOverallBuckets
- func (r *GetOverallBuckets) AllowNoMatch(allownomatch bool) *GetOverallBuckets
- func (r *GetOverallBuckets) BucketSpan(duration types.Duration) *GetOverallBuckets
- func (r GetOverallBuckets) Do(providedCtx context.Context) (*Response, error)
- func (r *GetOverallBuckets) End(datetime types.DateTime) *GetOverallBuckets
- func (r *GetOverallBuckets) ExcludeInterim(excludeinterim bool) *GetOverallBuckets
- func (r *GetOverallBuckets) Header(key, value string) *GetOverallBuckets
- func (r *GetOverallBuckets) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetOverallBuckets) OverallScore(overallscore string) *GetOverallBuckets
- func (r GetOverallBuckets) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetOverallBuckets) Raw(raw io.Reader) *GetOverallBuckets
- func (r *GetOverallBuckets) Request(req *Request) *GetOverallBuckets
- func (r *GetOverallBuckets) Start(datetime types.DateTime) *GetOverallBuckets
- func (r *GetOverallBuckets) TopN(topn int) *GetOverallBuckets
- type NewGetOverallBuckets
- 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 GetOverallBuckets ¶
type GetOverallBuckets struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetOverallBuckets
Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html
func (*GetOverallBuckets) AllowNoMatch ¶
func (r *GetOverallBuckets) AllowNoMatch(allownomatch bool) *GetOverallBuckets
AllowNoMatch Refer to the description for the `allow_no_match` query parameter. API name: allow_no_match
func (*GetOverallBuckets) BucketSpan ¶
func (r *GetOverallBuckets) BucketSpan(duration types.Duration) *GetOverallBuckets
BucketSpan Refer to the description for the `bucket_span` query parameter. API name: bucket_span
func (GetOverallBuckets) Do ¶
func (r GetOverallBuckets) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getoverallbuckets.Response
func (*GetOverallBuckets) End ¶
func (r *GetOverallBuckets) End(datetime types.DateTime) *GetOverallBuckets
End Refer to the description for the `end` query parameter. API name: end
func (*GetOverallBuckets) ExcludeInterim ¶
func (r *GetOverallBuckets) ExcludeInterim(excludeinterim bool) *GetOverallBuckets
ExcludeInterim Refer to the description for the `exclude_interim` query parameter. API name: exclude_interim
func (*GetOverallBuckets) Header ¶
func (r *GetOverallBuckets) Header(key, value string) *GetOverallBuckets
Header set a key, value pair in the GetOverallBuckets headers map.
func (*GetOverallBuckets) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetOverallBuckets) OverallScore ¶
func (r *GetOverallBuckets) OverallScore(overallscore string) *GetOverallBuckets
OverallScore Refer to the description for the `overall_score` query parameter. API name: overall_score
func (GetOverallBuckets) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetOverallBuckets) Raw ¶
func (r *GetOverallBuckets) Raw(raw io.Reader) *GetOverallBuckets
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*GetOverallBuckets) Request ¶
func (r *GetOverallBuckets) Request(req *Request) *GetOverallBuckets
Request allows to set the request property with the appropriate payload.
func (*GetOverallBuckets) Start ¶
func (r *GetOverallBuckets) Start(datetime types.DateTime) *GetOverallBuckets
Start Refer to the description for the `start` query parameter. API name: start
func (*GetOverallBuckets) TopN ¶
func (r *GetOverallBuckets) TopN(topn int) *GetOverallBuckets
TopN Refer to the description for the `top_n` query parameter. API name: top_n
type NewGetOverallBuckets ¶
type NewGetOverallBuckets func(jobid string) *GetOverallBuckets
NewGetOverallBuckets type alias for index.
func NewGetOverallBucketsFunc ¶
func NewGetOverallBucketsFunc(tp elastictransport.Interface) NewGetOverallBuckets
NewGetOverallBucketsFunc returns a new instance of GetOverallBuckets 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"`
// BucketSpan Refer to the description for the `bucket_span` query parameter.
BucketSpan types.Duration `json:"bucket_span,omitempty"`
// End Refer to the description for the `end` query parameter.
End types.DateTime `json:"end,omitempty"`
// ExcludeInterim Refer to the description for the `exclude_interim` query parameter.
ExcludeInterim *bool `json:"exclude_interim,omitempty"`
// OverallScore Refer to the description for the `overall_score` query parameter.
OverallScore string `json:"overall_score,omitempty"`
// Start Refer to the description for the `start` query parameter.
Start types.DateTime `json:"start,omitempty"`
// TopN Refer to the description for the `top_n` query parameter.
TopN *int `json:"top_n,omitempty"`
}
Request holds the request body struct for the package getoverallbuckets
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
func (*Request) UnmarshalJSON ¶ added in v8.12.1
type Response ¶ added in v8.7.0
type Response struct {
Count int64 `json:"count"`
// OverallBuckets Array of overall bucket objects
OverallBuckets []types.OverallBucket `json:"overall_buckets"`
}
Response holds the response body struct for the package getoverallbuckets
Source Files