Skip to content

Commit 82dc60a

Browse files
committed
Add new params to cat segments API
1 parent c5e3b91 commit 82dc60a

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

specification/cat/segments/CatSegmentsRequest.ts

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
* under the License.
1818
*/
1919

20-
import { Indices, Names } from '@_types/common'
20+
import {ExpandWildcards, Indices, Names} from '@_types/common'
2121
import { Duration } from '@_types/Time'
2222
import { CatRequestBase, CatSegmentsColumns } from '@cat/_types/CatBase'
2323

@@ -79,5 +79,35 @@ export interface Request extends CatRequestBase {
7979
* @server_default 30s
8080
*/
8181
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
82112
}
83113
}

0 commit comments

Comments
 (0)