Files
elasticsearch-js/docs/reference-shutdown-put_node.asciidoc
2024-12-05 14:46:46 -06:00

67 lines
4.1 KiB
Plaintext

[[reference-shutdown-put_node]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.shutdown.putNode
Adds a node to be shut down. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
https://www.elastic.co/guide/en/elasticsearch/reference/current[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ShutdownPutNodeRequest, options?): Promise<ShutdownPutNodeResponse>
----
[discrete]
===== `ShutdownPutNodeRequest`
[source,ts]
----
interface ShutdownPutNodeRequest extends <<shared-type-request-base, RequestBase>> {
node_id: <<shared-type-node-id, NodeId>>
master_timeout?: <<shared-type-time-unit, TimeUnit>>
timeout?: <<shared-type-time-unit, TimeUnit>>
type: ShutdownType
reason: string
allocation_delay?: string
target_node_name?: string
}
----
[discrete]
===== `ShutdownPutNodeResponse`
[source,ts]
----
type ShutdownPutNodeResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
----