habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix table formatting

Browse Source
This commit is contained in:
Josh Mock
2025-05-27 16:07:27 -05:00
parent e996782c53
commit 0284ec5b1a
43 changed files with 1332 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/reference/api/AsyncSearch.md
View File

File diff suppressed because one or more lines are too long

13
docs/reference/api/Autoscaling.md
View File

File diff suppressed because one or more lines are too long

79
docs/reference/api/Cat.md
View File

File diff suppressed because one or more lines are too long

40
docs/reference/api/Ccr.md
View File

File diff suppressed because one or more lines are too long

3
docs/reference/api/Client.md
View File

@ -21,4 +21,5 @@ new Client(opts: [ClientOptions](./ClientOptions.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `child` | `child(opts: [ClientOptions](./ClientOptions.md)): [Client](./Client.md);` | Creates a child client instance that shared its connection pool with the parent client || `close` | `close(): Promise<void>;` | Closes all connections in the connection pool. Connections shared with any parent or child instances will also be closed. | | `child` | `child(opts: [ClientOptions](./ClientOptions.md)): [Client](./Client.md);` | Creates a child client instance that shared its connection pool with the parent client |
| `close` | `close(): Promise<void>;` | Closes all connections in the connection pool. Connections shared with any parent or child instances will also be closed. |

49
docs/reference/api/Cluster.md
View File

File diff suppressed because one or more lines are too long

103
docs/reference/api/Connector.md
View File

File diff suppressed because one or more lines are too long

10
docs/reference/api/DanglingIndices.md
View File

@ -17,4 +17,12 @@ new DanglingIndices(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md)>;` | Delete a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. || `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md), unknown>>;` | &nbsp; || `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md)>;` | &nbsp; || `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md)>;` | Import a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. || `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md), unknown>>;` | &nbsp; || `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md)>;` | &nbsp; || `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md)>;` | Get the dangling indices. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete. || `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md), unknown>>;` | &nbsp; || `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md)>;` | &nbsp; | | `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md)>;` | Delete a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. |
| `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md), unknown>>;` | &nbsp; |
| `deleteDanglingIndex` | `deleteDanglingIndex(this: [That](./That.md), params: [DanglingIndicesDeleteDanglingIndexRequest](./DanglingIndicesDeleteDanglingIndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesDeleteDanglingIndexResponse](./DanglingIndicesDeleteDanglingIndexResponse.md)>;` | &nbsp; |
| `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md)>;` | Import a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. |
| `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md), unknown>>;` | &nbsp; |
| `importDanglingIndex` | `importDanglingIndex(this: [That](./That.md), params: [DanglingIndicesImportDanglingIndexRequest](./DanglingIndicesImportDanglingIndexRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesImportDanglingIndexResponse](./DanglingIndicesImportDanglingIndexResponse.md)>;` | &nbsp; |
| `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md)>;` | Get the dangling indices. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete. |
| `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md), unknown>>;` | &nbsp; |
| `listDanglingIndices` | `listDanglingIndices(this: [That](./That.md), params?: [DanglingIndicesListDanglingIndicesRequest](./DanglingIndicesListDanglingIndicesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[DanglingIndicesListDanglingIndicesResponse](./DanglingIndicesListDanglingIndicesResponse.md)>;` | &nbsp; |

16
docs/reference/api/Enrich.md
View File

@ -17,4 +17,18 @@ new Enrich(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` | Delete an enrich policy. Deletes an existing enrich policy and its enrich index. || `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md), unknown>>;` | &nbsp; || `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` | &nbsp; || `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` | Run an enrich policy. Create the enrich index for an existing enrich policy. || `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md), unknown>>;` | &nbsp; || `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` | &nbsp; || `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` | Get an enrich policy. Returns information about an enrich policy. || `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md), unknown>>;` | &nbsp; || `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` | &nbsp; || `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` | Create an enrich policy. Creates an enrich policy. || `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md), unknown>>;` | &nbsp; || `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` | &nbsp; || `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` | Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing. || `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichStatsResponse](./EnrichStatsResponse.md), unknown>>;` | &nbsp; || `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` | &nbsp; | | `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` | Delete an enrich policy. Deletes an existing enrich policy and its enrich index. |
| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md), unknown>>;` | &nbsp; |
| `deletePolicy` | `deletePolicy(this: [That](./That.md), params: [EnrichDeletePolicyRequest](./EnrichDeletePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichDeletePolicyResponse](./EnrichDeletePolicyResponse.md)>;` | &nbsp; |
| `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` | Run an enrich policy. Create the enrich index for an existing enrich policy. |
| `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md), unknown>>;` | &nbsp; |
| `executePolicy` | `executePolicy(this: [That](./That.md), params: [EnrichExecutePolicyRequest](./EnrichExecutePolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichExecutePolicyResponse](./EnrichExecutePolicyResponse.md)>;` | &nbsp; |
| `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` | Get an enrich policy. Returns information about an enrich policy. |
| `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md), unknown>>;` | &nbsp; |
| `getPolicy` | `getPolicy(this: [That](./That.md), params?: [EnrichGetPolicyRequest](./EnrichGetPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichGetPolicyResponse](./EnrichGetPolicyResponse.md)>;` | &nbsp; |
| `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` | Create an enrich policy. Creates an enrich policy. |
| `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md), unknown>>;` | &nbsp; |
| `putPolicy` | `putPolicy(this: [That](./That.md), params: [EnrichPutPolicyRequest](./EnrichPutPolicyRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichPutPolicyResponse](./EnrichPutPolicyResponse.md)>;` | &nbsp; |
| `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` | Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing. |
| `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EnrichStatsResponse](./EnrichStatsResponse.md), unknown>>;` | &nbsp; |
| `stats` | `stats(this: [That](./That.md), params?: [EnrichStatsRequest](./EnrichStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EnrichStatsResponse](./EnrichStatsResponse.md)>;` | &nbsp; |

13
docs/reference/api/Eql.md
View File

@ -17,4 +17,15 @@ new Eql(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlDeleteResponse](./EqlDeleteResponse.md)>;` | Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search. || `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlDeleteResponse](./EqlDeleteResponse.md), unknown>>;` | &nbsp; || `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlDeleteResponse](./EqlDeleteResponse.md)>;` | &nbsp; || `get` | `get<TEvent = unknown>(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlGetResponse](./EqlGetResponse.md)<TEvent>>;` | Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search. || `get` | `get<TEvent = unknown>(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlGetResponse](./EqlGetResponse.md)<TEvent>, unknown>>;` | &nbsp; || `get` | `get<TEvent = unknown>(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlGetResponse](./EqlGetResponse.md)<TEvent>>;` | &nbsp; || `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlGetStatusResponse](./EqlGetStatusResponse.md)>;` | Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results. || `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlGetStatusResponse](./EqlGetStatusResponse.md), unknown>>;` | &nbsp; || `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlGetStatusResponse](./EqlGetStatusResponse.md)>;` | &nbsp; || `search` | `search<TEvent = unknown>(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlSearchResponse](./EqlSearchResponse.md)<TEvent>>;` | Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event. || `search` | `search<TEvent = unknown>(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlSearchResponse](./EqlSearchResponse.md)<TEvent>, unknown>>;` | &nbsp; || `search` | `search<TEvent = unknown>(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlSearchResponse](./EqlSearchResponse.md)<TEvent>>;` | &nbsp; | | `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlDeleteResponse](./EqlDeleteResponse.md)>;` | Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search. |
| `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlDeleteResponse](./EqlDeleteResponse.md), unknown>>;` | &nbsp; |
| `delete` | `delete(this: [That](./That.md), params: [EqlDeleteRequest](./EqlDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlDeleteResponse](./EqlDeleteResponse.md)>;` | &nbsp; |
| `get` | `get<TEvent = unknown>(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlGetResponse](./EqlGetResponse.md)<TEvent>>;` | Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search. |
| `get` | `get<TEvent = unknown>(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlGetResponse](./EqlGetResponse.md)<TEvent>, unknown>>;` | &nbsp; |
| `get` | `get<TEvent = unknown>(this: [That](./That.md), params: [EqlGetRequest](./EqlGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlGetResponse](./EqlGetResponse.md)<TEvent>>;` | &nbsp; |
| `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlGetStatusResponse](./EqlGetStatusResponse.md)>;` | Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results. |
| `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlGetStatusResponse](./EqlGetStatusResponse.md), unknown>>;` | &nbsp; |
| `getStatus` | `getStatus(this: [That](./That.md), params: [EqlGetStatusRequest](./EqlGetStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlGetStatusResponse](./EqlGetStatusResponse.md)>;` | &nbsp; |
| `search` | `search<TEvent = unknown>(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EqlSearchResponse](./EqlSearchResponse.md)<TEvent>>;` | Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event. |
| `search` | `search<TEvent = unknown>(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EqlSearchResponse](./EqlSearchResponse.md)<TEvent>, unknown>>;` | &nbsp; |
| `search` | `search<TEvent = unknown>(this: [That](./That.md), params: [EqlSearchRequest](./EqlSearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EqlSearchResponse](./EqlSearchResponse.md)<TEvent>>;` | &nbsp; |

22
docs/reference/api/Esql.md
View File

File diff suppressed because one or more lines are too long

7
docs/reference/api/Features.md
View File

@ -17,4 +17,9 @@ new Features(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md)>;` | Get the features. Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot. You can use this API to determine which feature states to include when taking a snapshot. By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. A feature state includes one or more system indices necessary for a given feature to function. In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. The features listed by this API are a combination of built-in features and features defined by plugins. In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. || `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md), unknown>>;` | &nbsp; || `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md)>;` | &nbsp; || `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md)>;` | Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. WARNING: Intended for development and testing use only. Do not reset features on a production cluster. Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices. The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature. Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins. To list the features that will be affected, use the get features API. IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. || `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md), unknown>>;` | &nbsp; || `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md)>;` | &nbsp; | | `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md)>;` | Get the features. Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot. You can use this API to determine which feature states to include when taking a snapshot. By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. A feature state includes one or more system indices necessary for a given feature to function. In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. The features listed by this API are a combination of built-in features and features defined by plugins. In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. |
| `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md), unknown>>;` | &nbsp; |
| `getFeatures` | `getFeatures(this: [That](./That.md), params?: [FeaturesGetFeaturesRequest](./FeaturesGetFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FeaturesGetFeaturesResponse](./FeaturesGetFeaturesResponse.md)>;` | &nbsp; |
| `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md)>;` | Reset the features. Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. WARNING: Intended for development and testing use only. Do not reset features on a production cluster. Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. This deletes all state information stored in system indices. The response code is HTTP 200 if the state is successfully reset for all features. It is HTTP 500 if the reset operation failed for any feature. Note that select features might provide a way to reset particular system indices. Using this API resets all features, both those that are built-in and implemented as plugins. To list the features that will be affected, use the get features API. IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes. |
| `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md), unknown>>;` | &nbsp; |
| `resetFeatures` | `resetFeatures(this: [That](./That.md), params?: [FeaturesResetFeaturesRequest](./FeaturesResetFeaturesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[FeaturesResetFeaturesResponse](./FeaturesResetFeaturesResponse.md)>;` | &nbsp; |

19
docs/reference/api/Fleet.md
View File

File diff suppressed because one or more lines are too long

4
docs/reference/api/Graph.md
View File

@ -17,4 +17,6 @@ new Graph(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GraphExploreResponse](./GraphExploreResponse.md)>;` | Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned. || `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GraphExploreResponse](./GraphExploreResponse.md), unknown>>;` | &nbsp; || `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GraphExploreResponse](./GraphExploreResponse.md)>;` | &nbsp; | | `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[GraphExploreResponse](./GraphExploreResponse.md)>;` | Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned. |
| `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[GraphExploreResponse](./GraphExploreResponse.md), unknown>>;` | &nbsp; |
| `explore` | `explore(this: [That](./That.md), params: [GraphExploreRequest](./GraphExploreRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[GraphExploreResponse](./GraphExploreResponse.md)>;` | &nbsp; |

7
docs/reference/api/Helpers.md
View File

@ -15,4 +15,9 @@ new Helpers(opts: [HelpersOptions](./HelpersOptions.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `bulk` | `bulk<TDocument = unknown>(options: [BulkHelperOptions](./BulkHelperOptions.md)<TDocument>, reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [BulkHelper](./BulkHelper.md)<TDocument>;` | Creates a bulk helper instance. Once you configure it, you can pick which operation to execute with the given dataset, index, create, update, and delete. || `esql` | `esql(params: [EsqlQueryRequest](./EsqlQueryRequest.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [EsqlHelper](./EsqlHelper.md);` | Creates an ES|QL helper instance, to help transform the data returned by an ES|QL query into easy-to-use formats. || `msearch` | `msearch(options?: [MsearchHelperOptions](./MsearchHelperOptions.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [MsearchHelper](./MsearchHelper.md);` | Creates a msearch helper instance. Once you configure it, you can use the provided `search` method to add new searches in the queue. || `scrollDocuments` | `scrollDocuments<TDocument = unknown>(params: [SearchRequest](./SearchRequest.md), options?: [ScrollSearchOptions](./ScrollSearchOptions.md)): [AsyncIterable](./AsyncIterable.md)<TDocument>;` | Runs a scroll search operation. This function returns an async iterator, allowing the user to use a for await loop to get all the documents of a given search. Each document is what you will find by running a scrollSearch and iterating on the hits array. This helper automatically adds `filter_path=hits.hits._source` to the querystring, as it will only need the documents source. || `scrollSearch` | `scrollSearch<TDocument = unknown, TAggregations = unknown>(params: [SearchRequest](./SearchRequest.md), options?: [ScrollSearchOptions](./ScrollSearchOptions.md)): [AsyncIterable](./AsyncIterable.md)<[ScrollSearchResponse](./ScrollSearchResponse.md)<TDocument, TAggregations>>;` | Runs a scroll search operation. This function returns an async iterator, allowing the user to use a for await loop to get all the results of a given search. Each result represents the entire body of a single scroll search request, if you just need to scroll the results, use scrollDocuments. This function handles automatically retries on 429 status code. || `search` | `search<TDocument = unknown>(params: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<Array<TDocument & { _id: [Id](./Id.md); }>>;` | Runs a search operation. The only difference between client.search and this utility, is that we are only returning the hits to the user and not the full ES response. This helper automatically adds `filter_path=hits.hits._source` to the querystring, as it will only need the documents source. | | `bulk` | `bulk<TDocument = unknown>(options: [BulkHelperOptions](./BulkHelperOptions.md)<TDocument>, reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [BulkHelper](./BulkHelper.md)<TDocument>;` | Creates a bulk helper instance. Once you configure it, you can pick which operation to execute with the given dataset, index, create, update, and delete. |
| `esql` | `esql(params: [EsqlQueryRequest](./EsqlQueryRequest.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [EsqlHelper](./EsqlHelper.md);` | Creates an ES|QL helper instance, to help transform the data returned by an ES|QL query into easy-to-use formats. |
| `msearch` | `msearch(options?: [MsearchHelperOptions](./MsearchHelperOptions.md), reqOptions?: [TransportRequestOptions](./TransportRequestOptions.md)): [MsearchHelper](./MsearchHelper.md);` | Creates a msearch helper instance. Once you configure it, you can use the provided `search` method to add new searches in the queue. |
| `scrollDocuments` | `scrollDocuments<TDocument = unknown>(params: [SearchRequest](./SearchRequest.md), options?: [ScrollSearchOptions](./ScrollSearchOptions.md)): [AsyncIterable](./AsyncIterable.md)<TDocument>;` | Runs a scroll search operation. This function returns an async iterator, allowing the user to use a for await loop to get all the documents of a given search. Each document is what you will find by running a scrollSearch and iterating on the hits array. This helper automatically adds `filter_path=hits.hits._source` to the querystring, as it will only need the documents source. |
| `scrollSearch` | `scrollSearch<TDocument = unknown, TAggregations = unknown>(params: [SearchRequest](./SearchRequest.md), options?: [ScrollSearchOptions](./ScrollSearchOptions.md)): [AsyncIterable](./AsyncIterable.md)<[ScrollSearchResponse](./ScrollSearchResponse.md)<TDocument, TAggregations>>;` | Runs a scroll search operation. This function returns an async iterator, allowing the user to use a for await loop to get all the results of a given search. Each result represents the entire body of a single scroll search request, if you just need to scroll the results, use scrollDocuments. This function handles automatically retries on 429 status code. |
| `search` | `search<TDocument = unknown>(params: [SearchRequest](./SearchRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<Array<TDocument & { _id: [Id](./Id.md); }>>;` | Runs a search operation. The only difference between client.search and this utility, is that we are only returning the hits to the user and not the full ES response. This helper automatically adds `filter_path=hits.hits._source` to the querystring, as it will only need the documents source. |

34
docs/reference/api/Ilm.md
View File

File diff suppressed because one or more lines are too long

82
docs/reference/api/Inference.md
View File

File diff suppressed because one or more lines are too long

37
docs/reference/api/Ingest.md
View File

File diff suppressed because one or more lines are too long

22
docs/reference/api/License.md
View File

File diff suppressed because one or more lines are too long

10
docs/reference/api/Logstash.md
View File

@ -17,4 +17,12 @@ new Logstash(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md)>;` | Delete a Logstash pipeline. Delete a pipeline that is used for Logstash Central Management. If the request succeeds, you receive an empty response with an appropriate status code. || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md), unknown>>;` | &nbsp; || `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md)>;` | &nbsp; || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md)>;` | Get Logstash pipelines. Get pipelines that are used for Logstash Central Management. || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md), unknown>>;` | &nbsp; || `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md)>;` | &nbsp; || `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md)>;` | Create or update a Logstash pipeline. Create a pipeline that is used for Logstash Central Management. If the specified pipeline exists, it is replaced. || `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md), unknown>>;` | &nbsp; || `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md)>;` | &nbsp; | | `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md)>;` | Delete a Logstash pipeline. Delete a pipeline that is used for Logstash Central Management. If the request succeeds, you receive an empty response with an appropriate status code. |
| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md), unknown>>;` | &nbsp; |
| `deletePipeline` | `deletePipeline(this: [That](./That.md), params: [LogstashDeletePipelineRequest](./LogstashDeletePipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashDeletePipelineResponse](./LogstashDeletePipelineResponse.md)>;` | &nbsp; |
| `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md)>;` | Get Logstash pipelines. Get pipelines that are used for Logstash Central Management. |
| `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md), unknown>>;` | &nbsp; |
| `getPipeline` | `getPipeline(this: [That](./That.md), params?: [LogstashGetPipelineRequest](./LogstashGetPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashGetPipelineResponse](./LogstashGetPipelineResponse.md)>;` | &nbsp; |
| `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md)>;` | Create or update a Logstash pipeline. Create a pipeline that is used for Logstash Central Management. If the specified pipeline exists, it is replaced. |
| `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md), unknown>>;` | &nbsp; |
| `putPipeline` | `putPipeline(this: [That](./That.md), params: [LogstashPutPipelineRequest](./LogstashPutPipelineRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[LogstashPutPipelineResponse](./LogstashPutPipelineResponse.md)>;` | &nbsp; |

10
docs/reference/api/Migration.md
View File

@ -17,4 +17,12 @@ new Migration(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md)>;` | Get deprecation information. Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. TIP: This APIs is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. || `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md), unknown>>;` | &nbsp; || `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md)>;` | &nbsp; || `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md)>;` | Get feature migration information. Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress. TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. || `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md), unknown>>;` | &nbsp; || `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md)>;` | &nbsp; || `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md)>;` | Start the feature migration. Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process. Some functionality might be temporarily unavailable during the migration process. TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. || `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md), unknown>>;` | &nbsp; || `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md)>;` | &nbsp; | | `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md)>;` | Get deprecation information. Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. TIP: This APIs is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. |
| `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md), unknown>>;` | &nbsp; |
| `deprecations` | `deprecations(this: [That](./That.md), params?: [MigrationDeprecationsRequest](./MigrationDeprecationsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationDeprecationsResponse](./MigrationDeprecationsResponse.md)>;` | &nbsp; |
| `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md)>;` | Get feature migration information. Version upgrades sometimes require changes to how features store configuration information and data in system indices. Check which features need to be migrated and the status of any migrations that are in progress. TIP: This API is designed for indirect use by the Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant. |
| `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md), unknown>>;` | &nbsp; |
| `getFeatureUpgradeStatus` | `getFeatureUpgradeStatus(this: [That](./That.md), params?: [MigrationGetFeatureUpgradeStatusRequest](./MigrationGetFeatureUpgradeStatusRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationGetFeatureUpgradeStatusResponse](./MigrationGetFeatureUpgradeStatusResponse.md)>;` | &nbsp; |
| `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md)>;` | Start the feature migration. Version upgrades sometimes require changes to how features store configuration information and data in system indices. This API starts the automatic migration process. Some functionality might be temporarily unavailable during the migration process. TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. |
| `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md), unknown>>;` | &nbsp; |
| `postFeatureUpgrade` | `postFeatureUpgrade(this: [That](./That.md), params?: [MigrationPostFeatureUpgradeRequest](./MigrationPostFeatureUpgradeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MigrationPostFeatureUpgradeResponse](./MigrationPostFeatureUpgradeResponse.md)>;` | &nbsp; |

220
docs/reference/api/Ml.md
View File

File diff suppressed because one or more lines are too long

4
docs/reference/api/Monitoring.md
View File

@ -17,4 +17,6 @@ new Monitoring(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `bulk` | `bulk<TDocument = unknown, TPartialDocument = unknown>(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md)<TDocument, TPartialDocument>, options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MonitoringBulkResponse](./MonitoringBulkResponse.md)>;` | Send monitoring data. This API is used by the monitoring features to send monitoring data. || `bulk` | `bulk<TDocument = unknown, TPartialDocument = unknown>(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md)<TDocument, TPartialDocument>, options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MonitoringBulkResponse](./MonitoringBulkResponse.md), unknown>>;` | &nbsp; || `bulk` | `bulk<TDocument = unknown, TPartialDocument = unknown>(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md)<TDocument, TPartialDocument>, options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MonitoringBulkResponse](./MonitoringBulkResponse.md)>;` | &nbsp; | | `bulk` | `bulk<TDocument = unknown, TPartialDocument = unknown>(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md)<TDocument, TPartialDocument>, options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[MonitoringBulkResponse](./MonitoringBulkResponse.md)>;` | Send monitoring data. This API is used by the monitoring features to send monitoring data. |
| `bulk` | `bulk<TDocument = unknown, TPartialDocument = unknown>(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md)<TDocument, TPartialDocument>, options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[MonitoringBulkResponse](./MonitoringBulkResponse.md), unknown>>;` | &nbsp; |
| `bulk` | `bulk<TDocument = unknown, TPartialDocument = unknown>(this: [That](./That.md), params: [MonitoringBulkRequest](./MonitoringBulkRequest.md)<TDocument, TPartialDocument>, options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[MonitoringBulkResponse](./MonitoringBulkResponse.md)>;` | &nbsp; |

22
docs/reference/api/Nodes.md
View File

File diff suppressed because one or more lines are too long

13
docs/reference/api/Profiling.md
View File

@ -17,4 +17,15 @@ new Profiling(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. || `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | &nbsp; || `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | &nbsp; || `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts raw stacktrace information from Universal Profiling. || `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | &nbsp; || `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | &nbsp; || `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Returns basic information about the status of Universal Profiling. || `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | &nbsp; || `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | &nbsp; || `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a list of topN functions from Universal Profiling. || `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | &nbsp; || `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | &nbsp; | | `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. |
| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | &nbsp; |
| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | &nbsp; |
| `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts raw stacktrace information from Universal Profiling. |
| `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | &nbsp; |
| `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | &nbsp; |
| `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Returns basic information about the status of Universal Profiling. |
| `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | &nbsp; |
| `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | &nbsp; |
| `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a list of topN functions from Universal Profiling. |
| `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | &nbsp; |
| `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | &nbsp; |

25
docs/reference/api/QueryRules.md
View File

File diff suppressed because one or more lines are too long

25
docs/reference/api/Rollup.md
View File

File diff suppressed because one or more lines are too long

31
docs/reference/api/SearchApplication.md
View File

File diff suppressed because one or more lines are too long

13
docs/reference/api/SearchableSnapshots.md
View File

@ -17,4 +17,15 @@ new SearchableSnapshots(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md)>;` | Get cache statistics. Get statistics about the shared cache for partially mounted indices. || `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md), unknown>>;` | &nbsp; || `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md)>;` | &nbsp; || `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md)>;` | Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices. || `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md), unknown>>;` | &nbsp; || `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md)>;` | &nbsp; || `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md)>;` | Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes. || `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md), unknown>>;` | &nbsp; || `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md)>;` | &nbsp; || `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md)>;` | Get searchable snapshot statistics. || `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md), unknown>>;` | &nbsp; || `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md)>;` | &nbsp; | | `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md)>;` | Get cache statistics. Get statistics about the shared cache for partially mounted indices. |
| `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md), unknown>>;` | &nbsp; |
| `cacheStats` | `cacheStats(this: [That](./That.md), params?: [SearchableSnapshotsCacheStatsRequest](./SearchableSnapshotsCacheStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsCacheStatsResponse](./SearchableSnapshotsCacheStatsResponse.md)>;` | &nbsp; |
| `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md)>;` | Clear the cache. Clear indices and data streams from the shared cache for partially mounted indices. |
| `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md), unknown>>;` | &nbsp; |
| `clearCache` | `clearCache(this: [That](./That.md), params?: [SearchableSnapshotsClearCacheRequest](./SearchableSnapshotsClearCacheRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsClearCacheResponse](./SearchableSnapshotsClearCacheResponse.md)>;` | &nbsp; |
| `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md)>;` | Mount a snapshot. Mount a snapshot as a searchable snapshot index. Do not use this API for snapshots managed by index lifecycle management (ILM). Manually mounting ILM-managed snapshots can interfere with ILM processes. |
| `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md), unknown>>;` | &nbsp; |
| `mount` | `mount(this: [That](./That.md), params: [SearchableSnapshotsMountRequest](./SearchableSnapshotsMountRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsMountResponse](./SearchableSnapshotsMountResponse.md)>;` | &nbsp; |
| `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md)>;` | Get searchable snapshot statistics. |
| `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md), unknown>>;` | &nbsp; |
| `stats` | `stats(this: [That](./That.md), params?: [SearchableSnapshotsStatsRequest](./SearchableSnapshotsStatsRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SearchableSnapshotsStatsResponse](./SearchableSnapshotsStatsResponse.md)>;` | &nbsp; |

193
docs/reference/api/Security.md
View File

File diff suppressed because one or more lines are too long

10
docs/reference/api/Shutdown.md
View File

@ -17,4 +17,12 @@ new Shutdown(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md)>;` | Cancel node shutdown preparations. Remove a node from the shutdown list so it can resume normal operations. You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. Shutdown requests are never removed automatically by Elasticsearch. NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator privileges feature is enabled, you must be an operator to use this API. || `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md), unknown>>;` | &nbsp; || `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md)>;` | &nbsp; || `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md)>;` | Get the shutdown status. Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled. The API returns status information for each part of the shut down process. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator privileges feature is enabled, you must be an operator to use this API. || `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md), unknown>>;` | &nbsp; || `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md)>;` | &nbsp; || `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md)>;` | Prepare a node to be shut down. NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster. If the operator privileges feature is enabled, you must be an operator to use this API. The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster. This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster. You must specify the type of shutdown: `restart`, `remove`, or `replace`. If a node is already being prepared for shutdown, you can use this API to change the shutdown type. IMPORTANT: This API does NOT terminate the Elasticsearch process. Monitor the node shutdown status to determine when it is safe to stop Elasticsearch. || `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md), unknown>>;` | &nbsp; || `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md)>;` | &nbsp; | | `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md)>;` | Cancel node shutdown preparations. Remove a node from the shutdown list so it can resume normal operations. You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. Shutdown requests are never removed automatically by Elasticsearch. NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator privileges feature is enabled, you must be an operator to use this API. |
| `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md), unknown>>;` | &nbsp; |
| `deleteNode` | `deleteNode(this: [That](./That.md), params: [ShutdownDeleteNodeRequest](./ShutdownDeleteNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownDeleteNodeResponse](./ShutdownDeleteNodeResponse.md)>;` | &nbsp; |
| `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md)>;` | Get the shutdown status. Get information about nodes that are ready to be shut down, have shut down preparations still in progress, or have stalled. The API returns status information for each part of the shut down process. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If the operator privileges feature is enabled, you must be an operator to use this API. |
| `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md), unknown>>;` | &nbsp; |
| `getNode` | `getNode(this: [That](./That.md), params?: [ShutdownGetNodeRequest](./ShutdownGetNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownGetNodeResponse](./ShutdownGetNodeResponse.md)>;` | &nbsp; |
| `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md)>;` | Prepare a node to be shut down. NOTE: This feature is designed for indirect use by Elastic Cloud, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. If you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster. If the operator privileges feature is enabled, you must be an operator to use this API. The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster. This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster. You must specify the type of shutdown: `restart`, `remove`, or `replace`. If a node is already being prepared for shutdown, you can use this API to change the shutdown type. IMPORTANT: This API does NOT terminate the Elasticsearch process. Monitor the node shutdown status to determine when it is safe to stop Elasticsearch. |
| `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md), unknown>>;` | &nbsp; |
| `putNode` | `putNode(this: [That](./That.md), params: [ShutdownPutNodeRequest](./ShutdownPutNodeRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[ShutdownPutNodeResponse](./ShutdownPutNodeResponse.md)>;` | &nbsp; |

4
docs/reference/api/Simulate.md
View File

@ -17,4 +17,6 @@ new Simulate(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SimulateIngestResponse](./SimulateIngestResponse.md)>;` | Simulate data ingestion. Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index. This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch. The API runs the default and final pipeline for that index against a set of documents provided in the body of the request. If a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would. No data is indexed into Elasticsearch. Instead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation. The transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result. This API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline. The simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index. By default, the pipeline definitions that are currently in the system are used. However, you can supply substitute pipeline definitions in the body of the request. These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request. || `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SimulateIngestResponse](./SimulateIngestResponse.md), unknown>>;` | &nbsp; || `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SimulateIngestResponse](./SimulateIngestResponse.md)>;` | &nbsp; | | `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SimulateIngestResponse](./SimulateIngestResponse.md)>;` | Simulate data ingestion. Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index. This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch. The API runs the default and final pipeline for that index against a set of documents provided in the body of the request. If a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would. No data is indexed into Elasticsearch. Instead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation. The transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result. This API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline. The simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index. By default, the pipeline definitions that are currently in the system are used. However, you can supply substitute pipeline definitions in the body of the request. These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request. |
| `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SimulateIngestResponse](./SimulateIngestResponse.md), unknown>>;` | &nbsp; |
| `ingest` | `ingest(this: [That](./That.md), params: [SimulateIngestRequest](./SimulateIngestRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SimulateIngestResponse](./SimulateIngestResponse.md)>;` | &nbsp; |

28
docs/reference/api/Slm.md
View File

File diff suppressed because one or more lines are too long

40
docs/reference/api/Snapshot.md
View File

File diff suppressed because one or more lines are too long

2
docs/reference/api/SniffingTransport.md
View File

@ -7,4 +7,4 @@
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `sniff` | `sniff(opts: [SniffOptions](./SniffOptions.md)): void;` | &nbsp; | | `sniff` | `sniff(opts: [SniffOptions](./SniffOptions.md)): void;` | &nbsp; |

19
docs/reference/api/Sql.md
View File

File diff suppressed because one or more lines are too long

4
docs/reference/api/Ssl.md
View File

@ -17,4 +17,6 @@ new Ssl(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SslCertificatesResponse](./SslCertificatesResponse.md)>;` | Get SSL certificates. Get information about the X.509 certificates that are used to encrypt communications in the cluster. The API returns a list that includes certificates from all TLS contexts including: - Settings for transport and HTTP interfaces - TLS settings that are used within authentication realms - TLS settings for remote monitoring exporters The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`. The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch. NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration. If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster. || `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SslCertificatesResponse](./SslCertificatesResponse.md), unknown>>;` | &nbsp; || `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SslCertificatesResponse](./SslCertificatesResponse.md)>;` | &nbsp; | | `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[SslCertificatesResponse](./SslCertificatesResponse.md)>;` | Get SSL certificates. Get information about the X.509 certificates that are used to encrypt communications in the cluster. The API returns a list that includes certificates from all TLS contexts including: - Settings for transport and HTTP interfaces - TLS settings that are used within authentication realms - TLS settings for remote monitoring exporters The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`. The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch. NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration. If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster. |
| `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[SslCertificatesResponse](./SslCertificatesResponse.md), unknown>>;` | &nbsp; |
| `certificates` | `certificates(this: [That](./That.md), params?: [SslCertificatesRequest](./SslCertificatesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[SslCertificatesResponse](./SslCertificatesResponse.md)>;` | &nbsp; |

22
docs/reference/api/Synonyms.md
View File

File diff suppressed because one or more lines are too long

10
docs/reference/api/Tasks.md
View File

File diff suppressed because one or more lines are too long

13
docs/reference/api/TextStructure.md
View File

File diff suppressed because one or more lines are too long

37
docs/reference/api/Transform.md
View File

File diff suppressed because one or more lines are too long

40
docs/reference/api/Watcher.md
View File

File diff suppressed because one or more lines are too long

7
docs/reference/api/Xpack.md
View File

@ -17,4 +17,9 @@ new Xpack(transport: [Transport](./Transport.md));
| Name | Signature | Description | | Name | Signature | Description |
| - | - | - | | - | - | - |
| `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[XpackInfoResponse](./XpackInfoResponse.md)>;` | Get information. The information provided by the API includes: * Build information including the build number and timestamp. * License information about the currently installed license. * Feature information for the features that are currently enabled and available under the current license. || `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[XpackInfoResponse](./XpackInfoResponse.md), unknown>>;` | &nbsp; || `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[XpackInfoResponse](./XpackInfoResponse.md)>;` | &nbsp; || `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[XpackUsageResponse](./XpackUsageResponse.md)>;` | Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics. || `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[XpackUsageResponse](./XpackUsageResponse.md), unknown>>;` | &nbsp; || `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[XpackUsageResponse](./XpackUsageResponse.md)>;` | &nbsp; | | `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[XpackInfoResponse](./XpackInfoResponse.md)>;` | Get information. The information provided by the API includes: * Build information including the build number and timestamp. * License information about the currently installed license. * Feature information for the features that are currently enabled and available under the current license. |
| `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[XpackInfoResponse](./XpackInfoResponse.md), unknown>>;` | &nbsp; |
| `info` | `info(this: [That](./That.md), params?: [XpackInfoRequest](./XpackInfoRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[XpackInfoResponse](./XpackInfoResponse.md)>;` | &nbsp; |
| `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[XpackUsageResponse](./XpackUsageResponse.md)>;` | Get usage information. Get information about the features that are currently enabled and available under the current license. The API also provides some usage statistics. |
| `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[XpackUsageResponse](./XpackUsageResponse.md), unknown>>;` | &nbsp; |
| `usage` | `usage(this: [That](./That.md), params?: [XpackUsageRequest](./XpackUsageRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[XpackUsageResponse](./XpackUsageResponse.md)>;` | &nbsp; |