schedule()

Sets the trigger that determines how often Elasticsearch evaluates the watcher.

Signature

schedule(spec: { interval: string }): void

Usage

schedule({ interval: '2h' })

Parameters

Field	Type	Description
`interval`	string	Run frequency. Supports Elasticsearch time units: `30m`, `1h`, `6h`, `1d`, etc.

Examples

schedule({ interval: '30m' })   // every 30 minutes
schedule({ interval: '1h' })    // every hour
schedule({ interval: '6h' })    // every 6 hours
schedule({ interval: '1d' })    // once a day

Resulting JSON

{
  "trigger": {
    "schedule": { "interval": "2h" }
  }
}