Skip to content

[Backport 9.1] Adds description for the 'frequency' parameter in responses #5268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 11, 2025
Merged

[Backport 9.1] Adds description for the 'frequency' parameter in responses #5268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7a13b2
Adds description for the 'frequency' parameter in responses (#5266)
kosabogi Sep 8, 2025
db9eb95
Merge branch '9.1' into backport-5266-to-9.1
pquentin Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions specification/ml/_types/Datafeed.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ export class Datafeed {
authorization?: DatafeedAuthorization
chunking_config?: ChunkingConfig
datafeed_id: Id
/**
* 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.
*/
frequency?: Duration
indices: string[]
indexes?: string[]
Expand Down
3 changes: 3 additions & 0 deletions specification/ml/update_datafeed/MlUpdateDatafeedResponse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ export class Response {
chunking_config: ChunkingConfig
delayed_data_check_config?: DelayedDataCheckConfig
datafeed_id: Id
/**
* 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.
*/
frequency?: Duration
indices: string[]
indices_options?: IndicesOptions
Expand Down