Skip to content

Auto-generated code for 9.2 #3094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JoshMock merged 1 commit into from
Jan 5, 2026
+50 −24
Merged

Auto-generated code for 9.2 #3094

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 25 additions & 12 deletions docs/reference/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---

Check notice on line 1 in docs/reference/api-reference.md

View workflow job for this annotation

GitHub Actions / docs-preview / build 

Irregular space detected. Run 'docs-builder format --write' to automatically fix all instances.
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html
comment: |
Expand Down Expand Up @@ -3468,18 +3468,31 @@
### Arguments [_arguments_cluster.health]

#### Request (object) [_request_cluster.health]
- **`index` (Optional, string \| string[])**: 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 `*`.
- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Whether to expand wildcard expression to concrete indices that are open, closed or both.
- **`level` (Optional, Enum("cluster" \| "indices" \| "shards"))**: Can be one of cluster, indices or shards. Controls the details level of the health information returned.
- **`local` (Optional, boolean)**: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
- **`master_timeout` (Optional, string \| -1 \| 0)**: 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.
- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: 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.
- **`wait_for_events` (Optional, Enum("immediate" \| "urgent" \| "high" \| "normal" \| "low" \| "languid"))**: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.
- **`wait_for_nodes` (Optional, string \| number)**: 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.
- **`wait_for_no_initializing_shards` (Optional, boolean)**: 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.
- **`wait_for_no_relocating_shards` (Optional, boolean)**: 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.
- **`wait_for_status` (Optional, Enum("green" \| "yellow" \| "red" \| "unknown" \| "unavailable"))**: 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.
- **`index` (Optional, string \| string[])**: A list of data streams, indices, and index aliases that limit the request.
Wildcard expressions (`*`) are supported.
To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Expand wildcard expression to concrete indices that are open, closed or both.
- **`level` (Optional, Enum("cluster" \| "indices" \| "shards"))**: Return health information at a specific level of detail.
- **`local` (Optional, boolean)**: If true, retrieve information from the local node only.
If false, retrieve information from the master node.
- **`master_timeout` (Optional, string \| -1 \| 0)**: The 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.
- **`timeout` (Optional, string \| -1 \| 0)**: The period to wait for a response.
If no response is received before the timeout expires, the request fails and returns an error.
- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: Wait for the specified number of active shards.
Use `all` to wait for all shards in the cluster to be active.
Use `0` to not wait.
- **`wait_for_events` (Optional, Enum("immediate" \| "urgent" \| "high" \| "normal" \| "low" \| "languid"))**: Wait until all currently queued events with the given priority are processed.
- **`wait_for_nodes` (Optional, string \| number)**: Wait until the specified number (N) of nodes is available.
It also accepts `>=N`, `<=N`, `>N` and `<N`.
Alternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.
- **`wait_for_no_initializing_shards` (Optional, boolean)**: Wait (until the timeout expires) for the cluster to have no shard initializations.
If false, the request does not wait for initializing shards.
- **`wait_for_no_relocating_shards` (Optional, boolean)**: Wait (until the timeout expires) for the cluster to have no shard relocations.
If false, the request not wait for relocating shards.
- **`wait_for_status` (Optional, Enum("green" \| "yellow" \| "red" \| "unknown" \| "unavailable"))**: Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).
A green status is better than yellow and yellow is better than red.
By default, the request does not wait for a particular status.

## client.cluster.info [_cluster.info]
Get cluster info.
Expand Down
37 changes: 25 additions & 12 deletions src/api/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16472,29 +16472,42 @@ export interface ClusterHealthIndexHealthStats {
}

export interface ClusterHealthRequest extends RequestBase {
/** 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 `*`. */
/** A comma-separated list of data streams, indices, and index aliases that limit the request.
* Wildcard expressions (`*`) are supported.
* To target all data streams and indices in a cluster, omit this parameter or use _all or `*`. */
index?: Indices
/** Whether to expand wildcard expression to concrete indices that are open, closed or both. */
/** Expand wildcard expression to concrete indices that are open, closed or both. */
expand_wildcards?: ExpandWildcards
/** Can be one of cluster, indices or shards. Controls the details level of the health information returned. */
/** Return health information at a specific level of detail. */
level?: Level
/** If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. */
/** If true, retrieve information from the local node only.
* If false, retrieve information from the master node. */
local?: boolean
/** 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. */
/** The 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. */
master_timeout?: Duration
/** Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. */
/** The period to wait for a response.
* If no response is received before the timeout expires, the request fails and returns an error. */
timeout?: Duration
/** 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. */
/** Wait for the specified number of active shards.
* Use `all` to wait for all shards in the cluster to be active.
* Use `0` to not wait. */
wait_for_active_shards?: WaitForActiveShards
/** Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. */
/** Wait until all currently queued events with the given priority are processed. */
wait_for_events?: WaitForEvents
/** 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. */
/** Wait until the specified number (N) of nodes is available.
* It also accepts `>=N`, `<=N`, `>N` and `<N`.
* Alternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`. */
wait_for_nodes?: ClusterHealthWaitForNodes
/** 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. */
/** Wait (until the timeout expires) for the cluster to have no shard initializations.
* If false, the request does not wait for initializing shards. */
wait_for_no_initializing_shards?: boolean
/** 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. */
/** Wait (until the timeout expires) for the cluster to have no shard relocations.
* If false, the request not wait for relocating shards. */
wait_for_no_relocating_shards?: boolean
/** 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. */
/** Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).
* A green status is better than yellow and yellow is better than red.
* By default, the request does not wait for a particular status. */
wait_for_status?: HealthStatus
/** All values in `body` will be added to the request body. */
body?: string | { [key: string]: any } & { index?: never, expand_wildcards?: never, level?: never, local?: never, master_timeout?: never, timeout?: never, wait_for_active_shards?: never, wait_for_events?: never, wait_for_nodes?: never, wait_for_no_initializing_shards?: never, wait_for_no_relocating_shards?: never, wait_for_status?: never }
Expand Down
Loading