@@ -22,22 +22,70 @@ import { ExpandWildcards, Indices, Names } from '@_types/common'
22
22
import { Duration } from '@_types/Time'
23
23
24
24
/**
25
+ * Returns setting information for one or more indices. For data streams,
26
+ * returns setting information for the stream’s backing indices.
25
27
* @rest_spec_name indices.get_settings
26
28
* @availability stack since=0.0.0 stability=stable
27
29
* @availability serverless stability=stable visibility=public
30
+ * @index_privileges view_index_metadata, monitor, manage
28
31
*/
29
32
export interface Request extends RequestBase {
30
33
path_parts : {
34
+ /**
35
+ * Comma-separated list of data streams, indices, and aliases used to limit
36
+ * the request. Supports wildcards (`*`). To target all data streams and
37
+ * indices, omit this parameter or use `*` or `_all`.
38
+ */
31
39
index ?: Indices
40
+ /**
41
+ * Comma-separated list or wildcard expression of settings to retrieve.
42
+ */
32
43
name ?: Names
33
44
}
34
45
query_parameters : {
46
+ /**
47
+ * If `false`, the request returns an error if any wildcard expression, index
48
+ * alias, or `_all` value targets only missing or closed indices. This
49
+ * behavior applies even if the request targets other open indices. For
50
+ * example, a request targeting `foo*,bar*` returns an error if an index
51
+ * starts with foo but no index starts with `bar`.
52
+ * @server_default true
53
+ */
35
54
allow_no_indices ?: boolean
55
+ /**
56
+ * Type of index that wildcard patterns can match.
57
+ * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
58
+ * Supports comma-separated values, such as `open,hidden`.
59
+ * @server_default open
60
+ */
36
61
expand_wildcards ?: ExpandWildcards
62
+ /**
63
+ * If `true`, returns settings in flat format.
64
+ * @server_default false
65
+ */
37
66
flat_settings ?: boolean
67
+ /**
68
+ * If `false`, the request returns an error if it targets a missing or closed index.
69
+ * @server_default false
70
+ */
38
71
ignore_unavailable ?: boolean
72
+ /**
73
+ * If `true`, return all default settings in the response.
74
+ * @server_default false
75
+ */
39
76
include_defaults ?: boolean
77
+ /**
78
+ * If `true`, the request retrieves information from the local node only. If
79
+ * `false`, information is retrieved from the master node.
80
+ * @server_default false
81
+ */
40
82
local ?: boolean
83
+ /**
84
+ * Period to wait for a connection to the master node. If no response is
85
+ * received before the timeout expires, the request fails and returns an
86
+ * error.
87
+ * @server_default 30s
88
+ */
41
89
master_timeout ?: Duration
42
90
}
43
91
}
0 commit comments