getmemorystats

Documentation

Overview

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.

Index

• Variables
• type GetMemoryStats
  • func New(tp elastictransport.Interface) *GetMemoryStats
  • func (r GetMemoryStats) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetMemoryStats) ErrorTrace(errortrace bool) *GetMemoryStats
  • func (r *GetMemoryStats) FilterPath(filterpaths ...string) *GetMemoryStats
  • func (r *GetMemoryStats) Header(key, value string) *GetMemoryStats
  • func (r *GetMemoryStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetMemoryStats) Human(human bool) *GetMemoryStats
  • func (r GetMemoryStats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetMemoryStats) MasterTimeout(duration string) *GetMemoryStats
  • func (r *GetMemoryStats) NodeId(nodeid string) *GetMemoryStats
  • func (r GetMemoryStats) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetMemoryStats) Pretty(pretty bool) *GetMemoryStats
  • func (r *GetMemoryStats) Timeout(duration string) *GetMemoryStats
• type NewGetMemoryStats
  • func NewGetMemoryStatsFunc(tp elastictransport.Interface) NewGetMemoryStats
• type Response
  • func NewResponse() *Response

Variables

var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Types

type GetMemoryStats

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

func New

func New(tp elastictransport.Interface) *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.

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

func (GetMemoryStats) Do

func (r GetMemoryStats) Do(providedCtx context.Context) (*Response, error)

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

func (*GetMemoryStats) ErrorTrace

func (r *GetMemoryStats) ErrorTrace(errortrace bool) *GetMemoryStats

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

func (*GetMemoryStats) FilterPath

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

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

func (*GetMemoryStats) Header

func (r *GetMemoryStats) Header(key, value string) *GetMemoryStats

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

func (*GetMemoryStats) HttpRequest

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

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

func (*GetMemoryStats) Human

func (r *GetMemoryStats) Human(human bool) *GetMemoryStats

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

func (GetMemoryStats) IsSuccess

func (r GetMemoryStats) IsSuccess(providedCtx context.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(duration string) *GetMemoryStats

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

func (*GetMemoryStats) NodeId

func (r *GetMemoryStats) NodeId(nodeid string) *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

func (r GetMemoryStats) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*GetMemoryStats) Pretty

func (r *GetMemoryStats) Pretty(pretty bool) *GetMemoryStats

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

func (*GetMemoryStats) Timeout

func (r *GetMemoryStats) Timeout(duration string) *GetMemoryStats

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

type NewGetMemoryStats

type NewGetMemoryStats func() *GetMemoryStats

NewGetMemoryStats type alias for index.

func NewGetMemoryStatsFunc

func NewGetMemoryStatsFunc(tp elastictransport.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

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

Response holds the response body struct for the package getmemorystats

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/get_memory_stats/MlGetMemoryStatsResponse.ts#L25-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response