github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-28 09:28:55 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add Searchable Snapshots APIs to HLRC (#68949)

Browse source 
This commit adds the Searchable Snapshots APIs (the mount snapshot API)
to the high-level REST client.
This commit is contained in:
Jason Tedor 2021-02-12 07:53:30 -05:00 • committed by GitHub
parent 4d9ebcaabc
commit 985ae9a1ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 602 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

40
docs/java-rest/high-level/searchable_snapshots/mount_snapshot.asciidoc Normal file
View file

@ -0,0 +1,40 @@
--
:api: searchable-snapshots-mount-snapshot
:request: MountSnapshotRequest
:response: MountSnapshotResponse
--
[role="xpack"]
[id="{upid}-{api}"]
=== Mount Snapshot API
[id="{upid}-{api}-request"]
==== Request
The Mount Snapshot API mounts a snapshot as a searchable snapshot.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> The name of the repository.
<2> The name of the snapshot.
<3> The name of the index in the snapshot to mount.
<4> (optional) The period to wait for a connection to the master node.
<5> (optional) If true, the request blocks until the operation is complete.
<6> (optional) The type of local storage to use for the mounted snapshot.
<7> (optional) The name of the index that will be created.
<8> (optional) Settings that should be added to the mounted index.
<9> (optional) Names of settings that should be unset when the index is mounted.
[id="{upid}-{api}-response"]
==== Response
The returned +{response}+ indicates if the mounted snapshot was restored.
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-response]
--------------------------------------------------
<1> The restore info of the mounted snapshot.
include::../execution.asciidoc[]