Test run of new docs

This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions

View File

@ -0,0 +1,67 @@
[[reference-cluster-get_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.cluster.getSettings
Returns cluster-wide settings. By default, it returns only settings that have been explicitly defined.
{ref}/cluster-get-settings.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ClusterGetSettingsRequest, options?): Promise<ClusterGetSettingsResponse>
----
[discrete]
===== `ClusterGetSettingsRequest`
[source,ts]
----
interface ClusterGetSettingsRequest extends <<shared-type-request-base, RequestBase>> {
flat_settings?: boolean
include_defaults?: boolean
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
}
----
[discrete]
===== `ClusterGetSettingsResponse`
[source,ts]
----
interface ClusterGetSettingsResponse {
persistent: Record<string, any>
transient: Record<string, any>
defaults?: Record<string, any>
}
----