co.elastic.clients.elasticsearch.shutdown.ElasticsearchShutdownClient Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.shutdown;
import co.elastic.clients.ApiClient;
import co.elastic.clients.elasticsearch._types.ElasticsearchException;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.transport.ElasticsearchTransport;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.JsonEndpoint;
import co.elastic.clients.transport.Transport;
import co.elastic.clients.transport.TransportOptions;
import co.elastic.clients.util.ObjectBuilder;
import java.io.IOException;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
/**
* Client for the shutdown namespace.
*/
public class ElasticsearchShutdownClient extends ApiClient {
public ElasticsearchShutdownClient(ElasticsearchTransport transport) {
super(transport, null);
}
public ElasticsearchShutdownClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions) {
super(transport, transportOptions);
}
@Override
public ElasticsearchShutdownClient withTransportOptions(@Nullable TransportOptions transportOptions) {
return new ElasticsearchShutdownClient(this.transport, transportOptions);
}
// ----- Endpoint: shutdown.delete_node
/**
* 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 Documentation
* on elastic.co
*/
public DeleteNodeResponse deleteNode(DeleteNodeRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) DeleteNodeRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* 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.
*
* @param fn
* a function that initializes a builder to create the
* {@link DeleteNodeRequest}
* @see Documentation
* on elastic.co
*/
public final DeleteNodeResponse deleteNode(Function> fn)
throws IOException, ElasticsearchException {
return deleteNode(fn.apply(new DeleteNodeRequest.Builder()).build());
}
// ----- Endpoint: shutdown.get_node
/**
* 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 Documentation
* on elastic.co
*/
public GetNodeResponse getNode(GetNodeRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) GetNodeRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* 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.
*
* @param fn
* a function that initializes a builder to create the
* {@link GetNodeRequest}
* @see Documentation
* on elastic.co
*/
public final GetNodeResponse getNode(Function> fn)
throws IOException, ElasticsearchException {
return getNode(fn.apply(new GetNodeRequest.Builder()).build());
}
/**
* 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 Documentation
* on elastic.co
*/
public GetNodeResponse getNode() throws IOException, ElasticsearchException {
return this.transport.performRequest(new GetNodeRequest.Builder().build(), GetNodeRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: shutdown.put_node
/**
* 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.
*
* @see Documentation
* on elastic.co
*/
public PutNodeResponse putNode(PutNodeRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint endpoint = (JsonEndpoint) PutNodeRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* 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.
*
* @param fn
* a function that initializes a builder to create the
* {@link PutNodeRequest}
* @see Documentation
* on elastic.co
*/
public final PutNodeResponse putNode(Function> fn)
throws IOException, ElasticsearchException {
return putNode(fn.apply(new PutNodeRequest.Builder()).build());
}
}