Files
elasticsearch-js/docs/reference-searchable_snapshots-mount.asciidoc
2024-12-05 14:46:52 -06:00

82 lines
4.1 KiB
Plaintext

[[reference-searchable_snapshots-mount]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.searchableSnapshots.mount]]
=== client.searchableSnapshots.mount
Mount a snapshot as a searchable index.
{ref}/searchable-snapshots-api-mount-snapshot.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SearchableSnapshotsMountRequest, options?): Promise<SearchableSnapshotsMountResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface SearchableSnapshotsMountRequest extends <<RequestBase>> {
repository: <<Name>>
snapshot: <<Name>>
master_timeout?: <<Duration>>
wait_for_completion?: boolean
storage?: string
index: <<IndexName>>
renamed_index?: <<IndexName>>
index_settings?: Record<string, any>
ignore_index_settings?: string[]
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
interface SearchableSnapshotsMountResponse {
snapshot: SearchableSnapshotsMountMountedSnapshot
}
[pass]
++++
</pre>
++++