Package co.elastic.clients.elasticsearch.shutdown

Class ElasticsearchShutdownClient

java.lang.Object
co.elastic.clients.ApiClient<ElasticsearchTransport,ElasticsearchShutdownClient>
co.elastic.clients.elasticsearch.shutdown.ElasticsearchShutdownClient
All Implemented Interfaces:
Closeable, AutoCloseable
public class ElasticsearchShutdownClient extends ApiClient<ElasticsearchTransport,ElasticsearchShutdownClient>
Client for the shutdown namespace.

  • Constructor Details

  • Method Details

    • withTransportOptions

      public ElasticsearchShutdownClient withTransportOptions(@Nullable TransportOptions transportOptions)
      Description copied from class: ApiClient
      Creates a new client with some request options
      Specified by:
      withTransportOptions in class ApiClient<ElasticsearchTransport,ElasticsearchShutdownClient>

    • deleteNode

      public DeleteNodeResponse deleteNode(DeleteNodeRequest request) throws IOException, ElasticsearchException
      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.

      Throws:
      IOException
      ElasticsearchException
      See Also:

    • deleteNode

      public final DeleteNodeResponse deleteNode(Function<DeleteNodeRequest.Builder,ObjectBuilder<DeleteNodeRequest>> fn) throws IOException, ElasticsearchException
      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.

      Parameters:
      fn - a function that initializes a builder to create the DeleteNodeRequest
      Throws:
      IOException
      ElasticsearchException
      See Also:

    • getNode

      public GetNodeResponse getNode(GetNodeRequest request) throws IOException, ElasticsearchException
      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.

      Throws:
      IOException
      ElasticsearchException
      See Also:

    • getNode

      public final GetNodeResponse getNode(Function<GetNodeRequest.Builder,ObjectBuilder<GetNodeRequest>> fn) throws IOException, ElasticsearchException
      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.

      Parameters:
      fn - a function that initializes a builder to create the GetNodeRequest
      Throws:
      IOException
      ElasticsearchException
      See Also:

    • getNode

      public GetNodeResponse getNode() throws IOException, ElasticsearchException
      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.

      Throws:
      IOException
      ElasticsearchException
      See Also:

    • putNode

      public PutNodeResponse putNode(PutNodeRequest request) throws IOException, ElasticsearchException
      Prepare a node to be shut down.

      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 you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster.

      If the operator privileges feature is enabled, you must be an operator to use this API.

      The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster. This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.

      You must specify the type of shutdown: restart, remove, or replace. If a node is already being prepared for shutdown, you can use this API to change the shutdown type.

      IMPORTANT: This API does NOT terminate the Elasticsearch process. Monitor the node shutdown status to determine when it is safe to stop Elasticsearch.

      Throws:
      IOException
      ElasticsearchException
      See Also:

    • putNode

      public final PutNodeResponse putNode(Function<PutNodeRequest.Builder,ObjectBuilder<PutNodeRequest>> fn) throws IOException, ElasticsearchException
      Prepare a node to be shut down.

      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 you specify a node that is offline, it will be prepared for shut down when it rejoins the cluster.

      If the operator privileges feature is enabled, you must be an operator to use this API.

      The API migrates ongoing tasks and index shards to other nodes as needed to prepare a node to be restarted or shut down and removed from the cluster. This ensures that Elasticsearch can be stopped safely with minimal disruption to the cluster.

      You must specify the type of shutdown: restart, remove, or replace. If a node is already being prepared for shutdown, you can use this API to change the shutdown type.

      IMPORTANT: This API does NOT terminate the Elasticsearch process. Monitor the node shutdown status to determine when it is safe to stop Elasticsearch.

      Parameters:
      fn - a function that initializes a builder to create the PutNodeRequest
      Throws:
      IOException
      ElasticsearchException
      See Also: