Files
elasticsearch-js/docs/reference-shared-types-search_shards.asciidoc

117 lines
4.9 KiB
Plaintext

[[reference-shared-types-search_shards]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
== Shared SearchShards types
[discrete]
[[SearchShardsRequest]]
=== SearchShardsRequest
[pass]
++++
<pre>
++++
interface SearchShardsRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_unavailable?: boolean
local?: boolean
preference?: string
routing?: <<Routing>>
}
[pass]
++++
</pre>
++++
[discrete]
[[SearchShardsResponse]]
=== SearchShardsResponse
[pass]
++++
<pre>
++++
interface SearchShardsResponse {
nodes: Record<<<NodeId>>, <<SearchShardsSearchShardsNodeAttributes>>>
shards: <<NodeShard>>[][]
indices: Record<<<IndexName>>, <<SearchShardsShardStoreIndex>>>
}
[pass]
++++
</pre>
++++
[discrete]
[[SearchShardsSearchShardsNodeAttributes]]
=== SearchShardsSearchShardsNodeAttributes
[pass]
++++
<pre>
++++
interface SearchShardsSearchShardsNodeAttributes {
pass:[/**] @property name The human-readable identifier of the node. */
name: <<NodeName>>
pass:[/**] @property ephemeral_id The ephemeral ID of the node. */
ephemeral_id: <<Id>>
pass:[/**] @property transport_address The host and port where transport HTTP connections are accepted. */
transport_address: <<TransportAddress>>
external_id: string
pass:[/**] @property attributes Lists node attributes. */
attributes: Record<string, string>
roles: <<NodeRoles>>
version: <<VersionString>>
min_index_version: <<integer>>
max_index_version: <<integer>>
}
[pass]
++++
</pre>
++++
[discrete]
[[SearchShardsShardStoreIndex]]
=== SearchShardsShardStoreIndex
[pass]
++++
<pre>
++++
interface SearchShardsShardStoreIndex {
aliases?: <<Name>>[]
filter?: <<QueryDslQueryContainer>>
}
[pass]
++++
</pre>
++++