elasticsearch/docs/reference/watcher/trigger/schedule/hourly.asciidoc
James Rodewig 255c9a7f95
[DOCS] Move x-pack docs to docs/reference dir (#99209)
**Problem:**
For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. 

**Solution:**
- Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory
- Update doc snippet tests to use security

Rel: https://github.com/elastic/platform-docs-team/issues/208
2023-09-12 14:53:41 -04:00

54 lines
No EOL
1.5 KiB
Text

[role="xpack"]
[[schedule-hourly]]
==== {watcher} hourly schedule
++++
<titleabbrev>Hourly schedule</titleabbrev>
++++
A <<trigger-schedule,`schedule`>> that triggers at a particular minute every
hour of the day. To use the `hourly` schedule, you specify the minute (or minutes)
when you want the scheduler to start the watch execution with the `minute`
attribute.
NOTE: If you don't specify the `minute` attribute for an `hourly` schedule, it
defaults to `0` and the schedule triggers on the hour every hour--`12:00`,
`13:00`, `14:00`, and so on.
===== Configuring a once an hour schedule
To configure a once an hour schedule, you specify a single time with the `minute`
attribute.
For example, the following `hourly` schedule triggers at minute 30 every hour--
`12:30`, `13:30`, `14:30`, ...:
[source,js]
--------------------------------------------------
{
"trigger" : {
"schedule" : {
"hourly" : { "minute" : 30 }
}
}
}
--------------------------------------------------
// NOTCONSOLE
===== Configuring a multiple times hourly schedule
To configure an `hourly` schedule that triggers at multiple times during the
hour, you specify an array of minutes. For example, the following schedule
triggers every 15 minutes every hour--`12:00`, `12:15`, `12:30`, `12:45`,
`1:00`, `1:15`, ...:
[source,js]
--------------------------------------------------
{
"trigger" : {
"schedule" : {
"hourly" : { "minute" : [ 0, 15, 30, 45 ] }
}
}
}
--------------------------------------------------
// NOTCONSOLE