Files
elasticsearch-js/docs/reference-indices-put_settings.asciidoc
2024-12-05 14:46:52 -06:00

80 lines
4.2 KiB
Plaintext

[[reference-indices-put_settings]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.indices.putSettings]]
=== client.indices.putSettings
Update index settings. Changes dynamic index settings in real time. For data streams, index setting changes are applied to all backing indices by default.
{ref}/indices-update-settings.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndicesPutSettingsRequest, options?): Promise<IndicesPutSettingsResponse>
----
[discrete]
==== IndicesPutSettingsRequest
[pass]
++++
<pre>
++++
interface IndicesPutSettingsRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
flat_settings?: boolean
ignore_unavailable?: boolean
master_timeout?: <<Duration>>
preserve_existing?: boolean
timeout?: <<Duration>>
settings?: IndicesIndexSettings
}
[pass]
++++
</pre>
++++
[discrete]
==== IndicesPutSettingsResponse
[pass]
++++
<pre>
++++
type IndicesPutSettingsResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++