Package co.elastic.clients.elasticsearch.ml

Class GetMemoryStatsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetMemoryStatsRequest

public class GetMemoryStatsRequest
extends RequestBase

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.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetMemoryStatsRequest.Builder	Builder for GetMemoryStatsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetMemoryStatsRequest,GetMemoryStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.get_memory_stats".

Method Summary

Modifier and Type	Method	Description
final Boolean	human()	Specify this query parameter to include the fields with units in the response.
final Time	masterTimeout()	Period to wait for a connection to the master node.
final String	nodeId()	The names of particular nodes in the cluster to target.
static GetMemoryStatsRequest	of(Function<GetMemoryStatsRequest.Builder,ObjectBuilder<GetMemoryStatsRequest>> fn)
final Time	timeout()	Period to wait for a response.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<GetMemoryStatsRequest,GetMemoryStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.get_memory_stats".

Method Details

of

public static GetMemoryStatsRequest of(Function<GetMemoryStatsRequest.Builder,ObjectBuilder<GetMemoryStatsRequest>> fn)

human

@Nullable
public final Boolean human()

Specify this query parameter to include the fields with units in the response. Otherwise only the _in_bytes sizes are returned in the response.

API name: human

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

nodeId

@Nullable
public final String nodeId()

The names of particular nodes in the cluster to target. For example, nodeId1,nodeId2 or ml:true

API name: node_id

timeout

@Nullable
public final Time timeout()

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout