Skip to content

Commit c17971b

Browse files
Add max_sample_per_keys to EqlSearchRequest (#3041) (#3409)
(cherry picked from commit 67591e6) Co-authored-by: Florian Bernd <[email protected]>
1 parent c86d74d commit c17971b

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

specification/eql/search/EqlSearchRequest.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import { RequestBase } from '@_types/Base'
2121
import { ExpandWildcards, Field, Indices } from '@_types/common'
2222
import { RuntimeFields } from '@_types/mapping/RuntimeFields'
23-
import { uint } from '@_types/Numeric'
23+
import { integer, uint } from '@_types/Numeric'
2424
import { FieldAndFormat, QueryContainer } from '@_types/query_dsl/abstractions'
2525
import { Duration } from '@_types/Time'
2626
import { ResultPosition } from './types'
@@ -131,5 +131,12 @@ export interface Request extends RequestBase {
131131
* @availability serverless
132132
*/
133133
runtime_mappings?: RuntimeFields
134+
/**
135+
* 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`
136+
* parameter to get a smaller or larger set of samples. To retrieve more than one sample per set of join keys, use the
137+
* `max_samples_per_key` parameter. Pipes are not supported for sample queries.
138+
* @server_default 1
139+
*/
140+
max_samples_per_key?: integer
134141
}
135142
}

0 commit comments

Comments
 (0)