Files
elasticsearch-js/docs/reference-ml-get_memory_stats.asciidoc
2024-12-05 14:46:46 -06:00

68 lines
4.2 KiB
Plaintext

[[reference-ml-get_memory_stats]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.ml.getMemoryStats
Get machine learning memory usage info. Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM.
{ref}/get-ml-memory.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlGetMemoryStatsRequest, options?): Promise<MlGetMemoryStatsResponse>
----
[discrete]
===== `MlGetMemoryStatsRequest`
[source,ts]
----
interface MlGetMemoryStatsRequest extends <<shared-type-request-base, RequestBase>> {
node_id?: <<shared-type-id, Id>>
human?: boolean
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
}
----
[discrete]
===== `MlGetMemoryStatsResponse`
[source,ts]
----
interface MlGetMemoryStatsResponse {
_nodes: <<shared-type-node-statistics, NodeStatistics>>
cluster_name: <<shared-type-name, Name>>
nodes: Record<<<shared-type-id, Id>>, MlGetMemoryStatsMemory>
}
----