The highest tagged major version is
Documentation
¶
Overview ¶
Cancel node shutdown preparations. Remove a node from the shutdown list so it can resume normal operations. You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. Shutdown requests are never removed automatically by Elasticsearch.
NOTE: This feature is designed for indirect use by Elastic Cloud, 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 DeleteNode
- func (r DeleteNode) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteNode) ErrorTrace(errortrace bool) *DeleteNode
- func (r *DeleteNode) FilterPath(filterpaths ...string) *DeleteNode
- func (r *DeleteNode) Header(key, value string) *DeleteNode
- func (r *DeleteNode) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DeleteNode) Human(human bool) *DeleteNode
- func (r DeleteNode) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *DeleteNode) MasterTimeout(mastertimeout timeunit.TimeUnit) *DeleteNode
- func (r DeleteNode) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteNode) Pretty(pretty bool) *DeleteNode
- func (r *DeleteNode) Timeout(timeout timeunit.TimeUnit) *DeleteNode
- type NewDeleteNode
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type DeleteNode ¶
type DeleteNode struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteNode
Cancel node shutdown preparations. Remove a node from the shutdown list so it can resume normal operations. You must explicitly clear the shutdown request when a node rejoins the cluster or when a node has permanently left the cluster. Shutdown requests are never removed automatically by Elasticsearch.
NOTE: This feature is designed for indirect use by Elastic Cloud, 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/guide/en/elasticsearch/reference/current/delete-shutdown.html
func (DeleteNode) Do ¶
func (r DeleteNode) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deletenode.Response
func (*DeleteNode) ErrorTrace ¶ added in v8.14.0
func (r *DeleteNode) ErrorTrace(errortrace bool) *DeleteNode
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*DeleteNode) FilterPath ¶ added in v8.14.0
func (r *DeleteNode) FilterPath(filterpaths ...string) *DeleteNode
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*DeleteNode) Header ¶
func (r *DeleteNode) Header(key, value string) *DeleteNode
Header set a key, value pair in the DeleteNode headers map.
func (*DeleteNode) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*DeleteNode) Human ¶ added in v8.14.0
func (r *DeleteNode) Human(human bool) *DeleteNode
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 (DeleteNode) IsSuccess ¶
func (r DeleteNode) 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 (*DeleteNode) MasterTimeout ¶
func (r *DeleteNode) MasterTimeout(mastertimeout timeunit.TimeUnit) *DeleteNode
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 (DeleteNode) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteNode) Pretty ¶ added in v8.14.0
func (r *DeleteNode) Pretty(pretty bool) *DeleteNode
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*DeleteNode) Timeout ¶
func (r *DeleteNode) Timeout(timeout timeunit.TimeUnit) *DeleteNode
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 NewDeleteNode ¶
type NewDeleteNode func(nodeid string) *DeleteNode
NewDeleteNode type alias for index.
func NewDeleteNodeFunc ¶
func NewDeleteNodeFunc(tp elastictransport.Interface) NewDeleteNode
NewDeleteNodeFunc returns a new instance of DeleteNode with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files