Skip to content

Commit efaf732

Browse files
committed
Adds frequency parameter description to the Datafeed.ts file
1 parent 98ec7ac commit efaf732

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

specification/ml/_types/Datafeed.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ export class Datafeed {
4343
authorization?: DatafeedAuthorization
4444
chunking_config?: ChunkingConfig
4545
datafeed_id: Id
46+
/**
47+
* The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example: `150s`. When `frequency` is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.
48+
*/
4649
frequency?: Duration
4750
indices: string[]
4851
indexes?: string[]

0 commit comments

Comments
 (0)