Package co.elastic.clients.elasticsearch.shutdown

Class DeleteNodeRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.shutdown.DeleteNodeRequest

public class DeleteNodeRequest
extends RequestBase

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.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DeleteNodeRequest,DeleteNodeResponse,ErrorResponse>	_ENDPOINT	Endpoint "shutdown.delete_node".

Method Summary

Modifier and Type	Method	Description
final TimeUnit	masterTimeout()	Period to wait for a connection to the master node.
final String	nodeId()	Required - The node id of node to be removed from the shutdown state
static DeleteNodeRequest	of(Function<DeleteNodeRequest.Builder,ObjectBuilder<DeleteNodeRequest>> fn)
final TimeUnit	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<DeleteNodeRequest,DeleteNodeResponse,ErrorResponse> _ENDPOINT

Endpoint "shutdown.delete_node".

Method Details

of

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

masterTimeout

@Nullable
public final TimeUnit 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

public final String nodeId()

Required - The node id of node to be removed from the shutdown state

API name: node_id

timeout

@Nullable
public final TimeUnit 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