|
17 | 17 | * under the License. |
18 | 18 | */ |
19 | 19 |
|
20 | | -import { Indices, Names } from '@_types/common' |
| 20 | +import {ExpandWildcards, Indices, Names} from '@_types/common' |
21 | 21 | import { Duration } from '@_types/Time' |
22 | 22 | import { CatRequestBase, CatSegmentsColumns } from '@cat/_types/CatBase' |
23 | 23 |
|
@@ -79,5 +79,35 @@ export interface Request extends CatRequestBase { |
79 | 79 | * @server_default 30s |
80 | 80 | */ |
81 | 81 | master_timeout?: Duration |
| 82 | + /** |
| 83 | + * Type of index that wildcard expressions can match. If the request can target data streams, this argument |
| 84 | + * determines whether wildcard expressions match hidden data streams. Supports comma-separated values, |
| 85 | + * such as open,hidden. |
| 86 | + * @server_default open |
| 87 | + */ |
| 88 | + expand_wildcards?: ExpandWildcards |
| 89 | + /** |
| 90 | + * If false, the request returns an error if any wildcard expression, index alias, or _all value targets only |
| 91 | + * missing or closed indices. This behavior applies even if the request targets other open indices. For example, |
| 92 | + * a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. |
| 93 | + * @server_default true |
| 94 | + */ |
| 95 | + allow_no_indices?: boolean |
| 96 | + /** |
| 97 | + * If true, concrete, expanded or aliased indices are ignored when frozen. |
| 98 | + * @server_default false |
| 99 | + */ |
| 100 | + ignore_throttled?: boolean |
| 101 | + /** |
| 102 | + * If true, missing or closed indices are not included in the response. |
| 103 | + * @server_default false |
| 104 | + */ |
| 105 | + ignore_unavailable?: boolean |
| 106 | + /** |
| 107 | + * If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour |
| 108 | + * of throwing an exception if index pattern matches closed indices |
| 109 | + * @server_default false |
| 110 | + */ |
| 111 | + allow_closed ?: boolean |
82 | 112 | } |
83 | 113 | } |
0 commit comments