getnode

Documentation

Overview

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.

Index

• Variables
• type GetNode
  • func New(tp elastictransport.Interface) *GetNode
  • func (r GetNode) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetNode) ErrorTrace(errortrace bool) *GetNode
  • func (r *GetNode) FilterPath(filterpaths ...string) *GetNode
  • func (r *GetNode) Header(key, value string) *GetNode
  • func (r *GetNode) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetNode) Human(human bool) *GetNode
  • func (r GetNode) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetNode) MasterTimeout(mastertimeout timeunit.TimeUnit) *GetNode
  • func (r *GetNode) NodeId(nodeid string) *GetNode
  • func (r GetNode) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetNode) Pretty(pretty bool) *GetNode
• type NewGetNode
  • func NewGetNodeFunc(tp elastictransport.Interface) NewGetNode
• 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 GetNode

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

func New

func New(tp elastictransport.Interface) *GetNode

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.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-shutdown-get-node

func (GetNode) Do

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

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

func (*GetNode) ErrorTrace

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

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

func (*GetNode) FilterPath

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

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

func (*GetNode) Header

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

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

func (*GetNode) HttpRequest

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

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

func (*GetNode) Human

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

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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (GetNode) IsSuccess

func (r GetNode) 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 (*GetNode) MasterTimeout

func (r *GetNode) MasterTimeout(mastertimeout timeunit.TimeUnit) *GetNode

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 (*GetNode) NodeId

func (r *GetNode) NodeId(nodeid string) *GetNode

NodeId Which node for which to retrieve the shutdown status API Name: nodeid

func (GetNode) Perform

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

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

func (*GetNode) Pretty

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

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

type NewGetNode

type NewGetNode func() *GetNode

NewGetNode type alias for index.

func NewGetNodeFunc

func NewGetNodeFunc(tp elastictransport.Interface) NewGetNode

NewGetNodeFunc returns a new instance of GetNode 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 {
	Nodes []types.NodeShutdownStatus `json:"nodes"`
}

Response holds the response body struct for the package getnode

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/shutdown/get_node/ShutdownGetNodeResponse.ts#L23-L27

func NewResponse

func NewResponse() *Response

NewResponse returns a Response