79 lines
4.1 KiB
Plaintext
79 lines
4.1 KiB
Plaintext
[[reference-indices-segments]]
|
||
|
||
////////
|
||
===========================================================================================================================
|
||
|| ||
|
||
|| ||
|
||
|| ||
|
||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||
|| ||
|
||
|| ||
|
||
|| 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.segments]]
|
||
=== client.indices.segments
|
||
|
||
Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices.
|
||
|
||
{ref}/indices-segments.html[{es} documentation]
|
||
|
||
[discrete]
|
||
==== Function signature
|
||
|
||
[source,ts]
|
||
----
|
||
(IndicesSegmentsRequest, options?): Promise<IndicesSegmentsResponse>
|
||
----
|
||
|
||
[discrete]
|
||
==== Request
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface IndicesSegmentsRequest extends <<RequestBase>> {
|
||
index?: <<Indices>>
|
||
allow_no_indices?: boolean
|
||
expand_wildcards?: <<ExpandWildcards>>
|
||
ignore_unavailable?: boolean
|
||
verbose?: boolean
|
||
}
|
||
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|
||
[discrete]
|
||
==== Response
|
||
|
||
[pass]
|
||
++++
|
||
<pre>
|
||
++++
|
||
interface IndicesSegmentsResponse {
|
||
indices: Record<string, IndicesSegmentsIndexSegment>
|
||
_shards: <<ShardStatistics>>
|
||
}
|
||
|
||
[pass]
|
||
++++
|
||
</pre>
|
||
++++
|