type GetMemoryStats struct {// contains filtered or unexported fields}

funcNew¶

func New(tpelastictransport.Interface) *GetMemoryStats

Get machine learning memory usage info.Get information about how machine learning jobs and trained models are usingmemory,on each node, both within the JVM heap, and natively, outside of the JVM.

https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html

func (GetMemoryStats)Do¶

func (rGetMemoryStats) Do(providedCtxcontext.Context) (*Response,error)

Do runs the request through the transport, handle the response and returns a getmemorystats.Response

func (*GetMemoryStats)ErrorTrace¶added inv8.14.0

func (r *GetMemoryStats) ErrorTrace(errortracebool) *GetMemoryStats

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace

func (*GetMemoryStats)FilterPath¶added inv8.14.0

func (r *GetMemoryStats) FilterPath(filterpaths ...string) *GetMemoryStats

FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path

func (*GetMemoryStats)Header¶

func (r *GetMemoryStats) Header(key, valuestring) *GetMemoryStats

Header set a key, value pair in the GetMemoryStats headers map.

func (*GetMemoryStats)HttpRequest¶

func (r *GetMemoryStats) HttpRequest(ctxcontext.Context) (*http.Request,error)

HttpRequest returns the http.Request object built from thegiven parameters.

func (*GetMemoryStats)Human¶

func (r *GetMemoryStats) Human(humanbool) *GetMemoryStats

Human When set to `true` will return statistics in a format suitable for humans.For example `"exists_time": "1h"` for humans and`"eixsts_time_in_millis": 3600000` for computers. When disabled the humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (GetMemoryStats)IsSuccess¶

func (rGetMemoryStats) IsSuccess(providedCtxcontext.Context) (bool,error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean.This only exists for endpoints without a request payload and allows for quick control flow.

func (*GetMemoryStats)MasterTimeout¶

func (r *GetMemoryStats) MasterTimeout(durationstring) *GetMemoryStats

MasterTimeout Period to wait for a connection to the master node. If no response isreceived before the timeoutexpires, the request fails and returns an error.API name: master_timeout

func (*GetMemoryStats)NodeId¶

func (r *GetMemoryStats) NodeId(nodeidstring) *GetMemoryStats

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

func (GetMemoryStats)Perform¶added inv8.7.0

func (rGetMemoryStats) Perform(providedCtxcontext.Context) (*http.Response,error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*GetMemoryStats)Pretty¶added inv8.14.0

func (r *GetMemoryStats) Pretty(prettybool) *GetMemoryStats

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty

func (*GetMemoryStats)Timeout¶

func (r *GetMemoryStats) Timeout(durationstring) *GetMemoryStats

Timeout Period to wait for a response. If no response is received before the timeoutexpires, the requestfails and returns an error.API name: timeout

type NewGetMemoryStats func() *GetMemoryStats

funcNewGetMemoryStatsFunc¶

func NewGetMemoryStatsFunc(tpelastictransport.Interface)NewGetMemoryStats

NewGetMemoryStatsFunc returns a new instance of GetMemoryStats with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.

type Response struct {ClusterNamestring                  `json:"cluster_name"`NodeStatstypes.NodeStatistics    `json:"_nodes"`Nodes       map[string]types.Memory `json:"nodes"`}

funcNewResponse¶added inv8.7.0

func NewResponse() *Response

NewResponse returns a Response