75 lines
4.3 KiB
Plaintext
75 lines
4.3 KiB
Plaintext
[[reference-ml-get_buckets]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
[discrete]
|
|
=== client.ml.getBuckets
|
|
|
|
Get anomaly detection job results for buckets. The API presents a chronological view of the records, grouped by bucket.
|
|
|
|
{ref}/ml-get-bucket.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(MlGetBucketsRequest, options?): Promise<MlGetBucketsResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `MlGetBucketsRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface MlGetBucketsRequest extends <<shared-type-request-base, RequestBase>> {
|
|
job_id: <<shared-type-id, Id>>
|
|
timestamp?: <<shared-type-date-time, DateTime>>
|
|
from?: <<shared-type-integer, integer>>
|
|
size?: <<shared-type-integer, integer>>
|
|
anomaly_score?: <<shared-type-double, double>>
|
|
desc?: boolean
|
|
end?: <<shared-type-date-time, DateTime>>
|
|
exclude_interim?: boolean
|
|
expand?: boolean
|
|
page?: MlPage
|
|
sort?: <<shared-type-field, Field>>
|
|
start?: <<shared-type-date-time, DateTime>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `MlGetBucketsResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface MlGetBucketsResponse {
|
|
buckets: MlBucketSummary[]
|
|
count: <<shared-type-long, long>>
|
|
}
|
|
----
|
|
|