Skip to content

Commit 742151e

Browse files
authored
Adds description for the 'frequency' parameter in responses (#5266)
* Adds frequency parameter description to the Datafeed.ts file * Adds missing description * Fixes code style errpr
1 parent 98ec7ac commit 742151e

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-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[]

specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ export class Response {
3535
chunking_config: ChunkingConfig
3636
delayed_data_check_config?: DelayedDataCheckConfig
3737
datafeed_id: Id
38+
/**
39+
* 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.
40+
*/
3841
frequency?: Duration
3942
indices: string[]
4043
indices_options?: IndicesOptions

0 commit comments

Comments
 (0)