OpenSearch/docs/reference/ml
Zachary Tong 6ae6f57d39
[7.x Backport] Force selection of calendar or fixed intervals (#41906)
The date_histogram accepts an interval which can be either a calendar
interval (DST-aware, leap seconds, arbitrary length of months, etc) or
fixed interval (strict multiples of SI units). Unfortunately this is inferred
by first trying to parse as a calendar interval, then falling back to fixed
if that fails.

This leads to confusing arrangement where `1d` == calendar, but
`2d` == fixed.  And if you want a day of fixed time, you have to
specify `24h` (e.g. the next smallest unit).  This arrangement is very
error-prone for users.

This PR adds `calendar_interval` and `fixed_interval` parameters to any
code that uses intervals (date_histogram, rollup, composite, datafeed, etc).
Calendar only accepts calendar intervals, fixed accepts any combination of
units (meaning `1d` can be used to specify `24h` in fixed time), and both
are mutually exclusive.

The old interval behavior is deprecated and will throw a deprecation warning.
It is also mutually exclusive with the two new parameters. In the future the
old dual-purpose interval will be removed.

The change applies to both REST and java clients.
2019-05-20 12:07:29 -04:00
..
apis [DOCS] Allow attribute substitution in titleabbrevs for Asciidoctor migration (#41574) 2019-04-30 13:46:45 -04:00
functions [DOCS] Cleans up xpackml attributes 2019-01-07 14:33:10 -08:00
images [DOCS] Remove unused screenshots 2019-01-10 11:10:25 -08:00
aggregations.asciidoc [7.x Backport] Force selection of calendar or fixed intervals (#41906) 2019-05-20 12:07:29 -04:00
categories.asciidoc [ML] Deprecate X-Pack centric ML endpoints (#36315) 2018-12-07 20:34:11 +00:00
configuring.asciidoc [DOCS] Cleans up xpackml attributes 2019-01-07 14:33:10 -08:00
customurl.asciidoc [ML] Deprecate X-Pack centric ML endpoints (#36315) 2018-12-07 20:34:11 +00:00
delayed-data-detection.asciidoc [DOCS] Delayed data annotations (#37939) 2019-01-28 13:04:38 -08:00
detector-custom-rules.asciidoc [ML] Deprecate X-Pack centric ML endpoints (#36315) 2018-12-07 20:34:11 +00:00
functions.asciidoc [DOCS] Cleans up xpackml attributes 2019-01-07 14:33:10 -08:00
populations.asciidoc [ML] Deprecate X-Pack centric ML endpoints (#36315) 2018-12-07 20:34:11 +00:00
stopping-ml.asciidoc [ML] Deprecate X-Pack centric ML endpoints (#36315) 2018-12-07 20:34:11 +00:00
transforms.asciidoc [DOCS] Use "source" instead of "inline" in ML docs (#40635) 2019-03-29 17:30:28 +00:00