You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
64
+
* A comma-separated list of data streams, indices, and index aliases that limit the request.
65
+
* Wildcard expressions (`*`) are supported.
66
+
* To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
65
67
*/
66
68
index?: Indices
67
69
}
68
70
query_parameters: {
69
71
/**
70
-
* Whether to expand wildcard expression to concrete indices that are open, closed or both.
72
+
* Expand wildcard expression to concrete indices that are open, closed or both.
71
73
* @server_default all
72
74
*/
73
75
expand_wildcards?: ExpandWildcards
74
76
/**
75
-
* Can be one of cluster, indices or shards. Controls the details level of the health information returned.
77
+
* Return health information at a specific level of detail.
76
78
* @server_default cluster
77
79
*/
78
80
level?: Level
79
81
/**
80
-
* If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
82
+
* If true, retrieve information from the local node only.
83
+
* If false, retrieve information from the master node.
81
84
* @server_default false
82
85
*/
83
86
local?: boolean
84
87
/**
85
-
* Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
88
+
* The period to wait for a connection to the master node.
89
+
* If no response is received before the timeout expires, the request fails and returns an error.
86
90
* @server_default 30s
87
91
*/
88
92
master_timeout?: Duration
89
93
/**
90
-
* Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
94
+
* The period to wait for a response.
95
+
* If no response is received before the timeout expires, the request fails and returns an error.
91
96
* @server_default 30s
92
97
*/
93
98
timeout?: Duration
94
99
/**
95
-
* A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.
100
+
* Wait for the specified number of active shards.
101
+
* Use `all` to wait for all shards in the cluster to be active.
102
+
* Use `0` to not wait.
96
103
* @server_default 0
97
104
*/
98
105
wait_for_active_shards?: WaitForActiveShards
99
106
/**
100
-
* Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.
107
+
* Wait until all currently queued events with the given priority are processed.
101
108
*/
102
109
wait_for_events?: WaitForEvents
103
110
/**
104
-
* The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.
111
+
* Wait until the specified number (N) of nodes is available.
112
+
* It also accepts `>=N`, `<=N`, `>N` and `<N`.
113
+
* Alternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.
105
114
*/
106
115
wait_for_nodes?: WaitForNodes
107
116
/**
108
-
* A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.
117
+
* Wait (until the timeout expires) for the cluster to have no shard initializations.
118
+
* If false, the request does not wait for initializing shards.
109
119
* @server_default false
110
120
*/
111
121
wait_for_no_initializing_shards?: boolean
112
122
/**
113
-
* A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.
123
+
* Wait (until the timeout expires) for the cluster to have no shard relocations.
124
+
* If false, the request not wait for relocating shards.
114
125
* @server_default false
115
126
*/
116
127
wait_for_no_relocating_shards?: boolean
117
128
/**
118
-
* One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.
129
+
* Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).
130
+
* A green status is better than yellow and yellow is better than red.
131
+
* By default, the request does not wait for a particular status.
0 commit comments