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

68 lines
4.2 KiB
Plaintext

[[reference-indices-resolve_index]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.resolveIndex
Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
{ref}/indices-resolve-index-api.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndicesResolveIndexRequest, options?): Promise<IndicesResolveIndexResponse>
----
[discrete]
===== `IndicesResolveIndexRequest`
[source,ts]
----
interface IndicesResolveIndexRequest extends <<shared-type-request-base, RequestBase>> {
name: <<shared-type-names, Names>>
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
ignore_unavailable?: boolean
allow_no_indices?: boolean
}
----
[discrete]
===== `IndicesResolveIndexResponse`
[source,ts]
----
interface IndicesResolveIndexResponse {
indices: IndicesResolveIndexResolveIndexItem[]
aliases: IndicesResolveIndexResolveIndexAliasItem[]
data_streams: IndicesResolveIndexResolveIndexDataStreamsItem[]
}
----