Package co.elastic.clients.elasticsearch.shutdown

Class GetNodeRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.shutdown.GetNodeRequest

public class GetNodeRequest
extends RequestBase

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.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GetNodeRequest,GetNodeResponse,ErrorResponse>	_ENDPOINT	Endpoint "shutdown.get_node".

Method Summary

Modifier and Type	Method	Description
final TimeUnit	masterTimeout()	Period to wait for a connection to the master node.
final List<String>	nodeId()	Which node for which to retrieve the shutdown status
static GetNodeRequest	of(Function<GetNodeRequest.Builder,ObjectBuilder<GetNodeRequest>> 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<GetNodeRequest,GetNodeResponse,ErrorResponse> _ENDPOINT

Endpoint "shutdown.get_node".

Method Details

of

public static GetNodeRequest of(Function<GetNodeRequest.Builder,ObjectBuilder<GetNodeRequest>> 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 List<String> nodeId()

Which node for which to retrieve the shutdown status

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