OpenSearch/docs/java-rest/high-level
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
..
ccr Introduce forget follower API (#39718) 2019-03-07 11:08:45 -05:00
cluster Docs: Cut down on high level rest client copy-and-paste-ness (#34125) 2018-09-28 14:48:11 -04:00
dataframe [ML] adding pivot.max_search_page_size option for setting paging size (#41920) (#42079) 2019-05-10 13:22:31 -05:00
document Remove support for internal versioning for concurrency control (#38254) 2019-02-05 20:53:35 +01:00
graph HLRC GraphClient and associated tests (#32366) 2018-08-21 13:29:18 +01:00
ilm [DOCS] fix HLRC ILM doc misreferenced tag 2018-11-27 14:28:25 -08:00
indices Deprecate types in rollover index API (#38039) 2019-02-04 16:07:45 -05:00
ingest REST high-level client: add simulate pipeline API (#31158) 2018-06-22 09:59:04 +02:00
licensing HLRC: add support for get license basic/trial status API (#33176) 2018-11-13 15:52:59 +01:00
migration Remove Migration Upgrade and Assistance APIs (#40075) 2019-03-18 13:46:56 -06:00
miscellaneous HLRC: Convert xpack methods to client side objects (#40705) 2019-04-04 11:06:44 -05:00
ml ML: Add upgrade mode docs, hlrc, and fix bug (#37942) 2019-01-30 06:51:11 -06:00
rollup [7.x Backport] Force selection of calendar or fixed intervals (#41906) 2019-05-20 12:07:29 -04:00
script HLRC: Add put stored script support to high-level rest client (#31323) 2018-09-09 13:47:47 +02:00
search Update the scroll example in the docs (#37394) 2019-01-14 13:03:00 +01:00
security Add support for API keys to access Elasticsearch (#38291) 2019-02-05 14:21:57 +11:00
snapshot Add Restore Snapshot High Level REST API 2018-07-24 16:17:09 +02:00
tasks fix dangling tag in TasksClientDocumentationIT (#39157) 2019-02-20 08:48:58 -08:00
watcher [DOCS] Various spelling corrections (#37046) 2019-01-07 14:44:12 +01:00
aggs-builders.asciidoc [DOCS] Update APIs grouping and ordering in REST high-level Client docs (#28497) 2018-02-02 17:19:50 +01:00
execution-no-req.asciidoc HLRC: Implement get-user-privileges API (#36292) 2018-12-12 15:12:49 +11:00
execution.asciidoc Add javadocs about expected exceptions to RestHighLevelClient (#36216) 2018-12-05 00:31:52 +01:00
getting-started.asciidoc Provide names for all artifact repositories (#41857) 2019-05-07 06:35:28 -04:00
index.asciidoc Docs: HLRC: refactor bulk, migrate and reindex apis (#35413) 2018-11-16 08:58:13 +01:00
java-builders.asciidoc Docs: Cut down on high level rest client copy-and-paste-ness (#34125) 2018-09-28 14:48:11 -04:00
migration.asciidoc Docs: Pin two IDs in the rest client (#40785) 2019-04-04 12:03:36 -04:00
query-builders.asciidoc added docs for `wrapper` query. 2018-03-14 11:51:22 +01:00
supported-apis.asciidoc [ML] Data Frame HLRC Get API (#40509) 2019-03-27 12:40:39 +00:00