1
2
3[[Elasticsearch_Namespaces_SearchableSnapshotsNamespace]]
4=== Elasticsearch\Namespaces\SearchableSnapshotsNamespace
5
6
7
8Class SearchableSnapshotsNamespace
9
10*Description*
11
12
13NOTE: this file is autogenerated using util/GenerateEndpoints.php
14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
15
16
17*Methods*
18
19The class defines the following methods:
20
21* <<Elasticsearch_Namespaces_SearchableSnapshotsNamespaceclearCache_clearCache,`clearCache()`>>
22* <<Elasticsearch_Namespaces_SearchableSnapshotsNamespacemount_mount,`mount()`>>
23* <<Elasticsearch_Namespaces_SearchableSnapshotsNamespacerepositoryStats_repositoryStats,`repositoryStats()`>>
24* <<Elasticsearch_Namespaces_SearchableSnapshotsNamespacestats_stats,`stats()`>>
25
26
27
28[[Elasticsearch_Namespaces_SearchableSnapshotsNamespaceclearCache_clearCache]]
29.`clearCache(array $params = [])`
30*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
31****
32[source,php]
33----
34/*
35$params['index']              = (list) A comma-separated list of index names
36$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
37$params['allow_no_indices']   = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
38$params['expand_wildcards']   = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,none,all) (Default = open)
39*/
40----
41****
42
43
44
45[[Elasticsearch_Namespaces_SearchableSnapshotsNamespacemount_mount]]
46.`mount(array $params = [])`
47*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
48****
49[source,php]
50----
51/*
52$params['repository']          = (string) The name of the repository containing the snapshot of the index to mount
53$params['snapshot']            = (string) The name of the snapshot of the index to mount
54$params['master_timeout']      = (time) Explicit operation timeout for connection to master node
55$params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning (Default = false)
56$params['storage']             = (string) Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy` (Default = )
57$params['body']                = (array) The restore configuration for mounting the snapshot as searchable (Required)
58*/
59----
60****
61
62
63
64[[Elasticsearch_Namespaces_SearchableSnapshotsNamespacerepositoryStats_repositoryStats]]
65.`repositoryStats(array $params = [])`
66*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
67****
68[source,php]
69----
70/*
71$params['repository'] = (string) The repository for which to get the stats for
72*/
73----
74****
75
76
77
78[[Elasticsearch_Namespaces_SearchableSnapshotsNamespacestats_stats]]
79.`stats(array $params = [])`
80*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
81****
82[source,php]
83----
84/*
85$params['index'] = (list) A comma-separated list of index names
86$params['level'] = (enum) Return stats aggregated at cluster, index or shard level (Options = cluster,indices,shards) (Default = indices)
87*/
88----
89****
90
91
92