Skip to content

[Backport 8.x] Add max_sample_per_keys to EqlSearchRequest #3409

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 1 commit into from
Jan 2, 2025
Merged

[Backport 8.x] Add max_sample_per_keys to EqlSearchRequest #3409

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion specification/eql/search/EqlSearchRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import { RequestBase } from '@_types/Base'
import { ExpandWildcards, Field, Indices } from '@_types/common'
import { RuntimeFields } from '@_types/mapping/RuntimeFields'
import { uint } from '@_types/Numeric'
import { integer, uint } from '@_types/Numeric'
import { FieldAndFormat, QueryContainer } from '@_types/query_dsl/abstractions'
import { Duration } from '@_types/Time'
import { ResultPosition } from './types'
Expand Down Expand Up @@ -131,5 +131,12 @@ export interface Request extends RequestBase {
* @availability serverless
*/
runtime_mappings?: RuntimeFields
/**
* By default, the response of a sample query contains up to `10` samples, with one sample per unique set of join keys. Use the `size`
* parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the
* `max_samples_per_key` parameter. Pipes are not supported for sample queries.
* @server_default 1
*/
max_samples_per_key?: integer
}
}
Loading