69 lines
4.3 KiB
Plaintext
69 lines
4.3 KiB
Plaintext
[[reference-indices-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.indices.getSettings
|
||
|
||
Get index settings. Returns setting information for one or more indices. For data streams, returns setting information for the stream’s backing indices.
|
||
|
||
{ref}/indices-get-settings.html[{es} documentation]
|
||
|
||
[discrete]
|
||
==== Function signature
|
||
|
||
[source,ts]
|
||
----
|
||
(IndicesGetSettingsRequest, options?): Promise<IndicesGetSettingsResponse>
|
||
----
|
||
|
||
[discrete]
|
||
===== `IndicesGetSettingsRequest`
|
||
|
||
[source,ts]
|
||
----
|
||
interface IndicesGetSettingsRequest extends <<shared-type-request-base, RequestBase>> {
|
||
index?: <<shared-type-indices, Indices>>
|
||
name?: <<shared-type-names, Names>>
|
||
allow_no_indices?: boolean
|
||
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
|
||
flat_settings?: boolean
|
||
ignore_unavailable?: boolean
|
||
include_defaults?: boolean
|
||
local?: boolean
|
||
master_timeout?: <<shared-type-duration, Duration>>
|
||
}
|
||
----
|
||
|
||
[discrete]
|
||
===== `IndicesGetSettingsResponse`
|
||
|
||
[source,ts]
|
||
----
|
||
type IndicesGetSettingsResponse = Record<<<shared-type-index-name, IndexName>>, IndicesIndexState>
|
||
----
|
||
|