From baca64ee2c925b8bc486f03ab8f000ad5b9deeda Mon Sep 17 00:00:00 2001 From: mattsdevop <44505636+mattsdevop@users.noreply.github.com> Date: Fri, 2 Feb 2024 10:40:55 -0500 Subject: [PATCH] Update period filtertype description (#1550) Update period filtertype description to correctly reflect the possible options for `unit` referenced in https://www.elastic.co/guide/en/elasticsearch/client/curator/current/fe_unit.html as `hours`, `days`, `weeks`, `months`, or `years` only. --- docs/asciidoc/filters.asciidoc | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/asciidoc/filters.asciidoc b/docs/asciidoc/filters.asciidoc index e401a9f4..a15f01f7 100644 --- a/docs/asciidoc/filters.asciidoc +++ b/docs/asciidoc/filters.asciidoc @@ -611,15 +611,15 @@ NOTE: Empty values and commented lines will result in the default value, if any, === Relative Periods A relative period will be reckoned relative to execution time, unless an <> timestamp is provided. Reckoning is truncated to the most -recent whole unit, where a <> can be one of `seconds`, `minutes`, -`hours`, `days`, `weeks`, `months`, or `years`. For example, if I selected -`hours` as my `unit`, and I began execution at 02:35, then the point of reckoning -would be 02:00. This is relatively easy with `days`, `months`, and `years`, but -slightly more complicated with `weeks`. Some users may wish to reckon weeks by -the ISO standard, which starts weeks on Monday. Others may wish to use Sunday -as the first day of the week. Both are acceptable options with the `period` -filter. The default behavior for `weeks` is to have Sunday be the start of the -week. This can be overridden with <> as follows: +recent whole unit, where a <> can be one of `hours`, `days`, `weeks`, +`months`, or `years`. For example, if I selected `hours` as my `unit`, and I +began execution at 02:35, then the point of reckoning would be 02:00. This is +relatively easy with `days`, `months`, and `years`, but slightly more complicated +with `weeks`. Some users may wish to reckon weeks by the ISO standard, which +starts weeks on Monday. Others may wish to use Sunday as the first day of the +week. Both are acceptable options with the `period` filter. The default behavior +for `weeks` is to have Sunday be the start of the week. This can be overridden +with <> as follows: [source,yaml] -------------