1 2 3[[Elasticsearch_Namespaces_SnapshotNamespace]] 4=== Elasticsearch\Namespaces\SnapshotNamespace 5 6 7 8Class SnapshotNamespace 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_SnapshotNamespacecleanupRepository_cleanupRepository,`cleanupRepository()`>> 22* <<Elasticsearch_Namespaces_SnapshotNamespaceclone_clone,`clone()`>> 23* <<Elasticsearch_Namespaces_SnapshotNamespacecreate_create,`create()`>> 24* <<Elasticsearch_Namespaces_SnapshotNamespacecreateRepository_createRepository,`createRepository()`>> 25* <<Elasticsearch_Namespaces_SnapshotNamespacedelete_delete,`delete()`>> 26* <<Elasticsearch_Namespaces_SnapshotNamespacedeleteRepository_deleteRepository,`deleteRepository()`>> 27* <<Elasticsearch_Namespaces_SnapshotNamespaceget_get,`get()`>> 28* <<Elasticsearch_Namespaces_SnapshotNamespacegetRepository_getRepository,`getRepository()`>> 29* <<Elasticsearch_Namespaces_SnapshotNamespacerestore_restore,`restore()`>> 30* <<Elasticsearch_Namespaces_SnapshotNamespacestatus_status,`status()`>> 31* <<Elasticsearch_Namespaces_SnapshotNamespaceverifyRepository_verifyRepository,`verifyRepository()`>> 32 33 34 35[[Elasticsearch_Namespaces_SnapshotNamespacecleanupRepository_cleanupRepository]] 36.`cleanupRepository(array $params = [])` 37**** 38[source,php] 39---- 40/* 41$params['repository'] = (string) A repository name 42$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 43$params['timeout'] = (time) Explicit operation timeout 44*/ 45---- 46**** 47 48 49 50[[Elasticsearch_Namespaces_SnapshotNamespaceclone_clone]] 51.`clone(array $params = [])` 52**** 53[source,php] 54---- 55/* 56$params['repository'] = (string) A repository name 57$params['snapshot'] = (string) The name of the snapshot to clone from 58$params['target_snapshot'] = (string) The name of the cloned snapshot to create 59$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 60$params['body'] = (array) The snapshot clone definition (Required) 61*/ 62---- 63**** 64 65 66 67[[Elasticsearch_Namespaces_SnapshotNamespacecreate_create]] 68.`create(array $params = [])` 69**** 70[source,php] 71---- 72/* 73$params['repository'] = (string) A repository name 74$params['snapshot'] = (string) A snapshot name 75$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 76$params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning (Default = false) 77$params['body'] = (array) The snapshot definition 78*/ 79---- 80**** 81 82 83 84[[Elasticsearch_Namespaces_SnapshotNamespacecreateRepository_createRepository]] 85.`createRepository(array $params = [])` 86**** 87[source,php] 88---- 89/* 90$params['repository'] = (string) A repository name 91$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 92$params['timeout'] = (time) Explicit operation timeout 93$params['verify'] = (boolean) Whether to verify the repository after creation 94$params['body'] = (array) The repository definition (Required) 95*/ 96---- 97**** 98 99 100 101[[Elasticsearch_Namespaces_SnapshotNamespacedelete_delete]] 102.`delete(array $params = [])` 103**** 104[source,php] 105---- 106/* 107$params['repository'] = (string) A repository name 108$params['snapshot'] = (string) A snapshot name 109$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 110*/ 111---- 112**** 113 114 115 116[[Elasticsearch_Namespaces_SnapshotNamespacedeleteRepository_deleteRepository]] 117.`deleteRepository(array $params = [])` 118**** 119[source,php] 120---- 121/* 122$params['repository'] = (list) Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. 123*/ 124---- 125**** 126 127 128 129[[Elasticsearch_Namespaces_SnapshotNamespaceget_get]] 130.`get(array $params = [])` 131**** 132[source,php] 133---- 134/* 135$params['repository'] = (string) A repository name 136$params['snapshot'] = (list) A comma-separated list of snapshot names 137$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 138$params['ignore_unavailable'] = (boolean) Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown 139$params['verbose'] = (boolean) Whether to show verbose snapshot info or only show the basic info found in the repository index blob 140*/ 141---- 142**** 143 144 145 146[[Elasticsearch_Namespaces_SnapshotNamespacegetRepository_getRepository]] 147.`getRepository(array $params = [])` 148**** 149[source,php] 150---- 151/* 152$params['repository'] = (list) A comma-separated list of repository names 153$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 154$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 155*/ 156---- 157**** 158 159 160 161[[Elasticsearch_Namespaces_SnapshotNamespacerestore_restore]] 162.`restore(array $params = [])` 163**** 164[source,php] 165---- 166/* 167$params['repository'] = (string) A repository name 168$params['snapshot'] = (string) A snapshot name 169$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 170$params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning (Default = false) 171$params['body'] = (array) Details of what to restore 172*/ 173---- 174**** 175 176 177 178[[Elasticsearch_Namespaces_SnapshotNamespacestatus_status]] 179.`status(array $params = [])` 180**** 181[source,php] 182---- 183/* 184$params['repository'] = (string) A repository name 185$params['snapshot'] = (list) A comma-separated list of snapshot names 186$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 187$params['ignore_unavailable'] = (boolean) Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown 188*/ 189---- 190**** 191 192 193 194[[Elasticsearch_Namespaces_SnapshotNamespaceverifyRepository_verifyRepository]] 195.`verifyRepository(array $params = [])` 196**** 197[source,php] 198---- 199/* 200$params['repository'] = (string) A repository name 201$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 202$params['timeout'] = (time) Explicit operation timeout 203*/ 204---- 205**** 206 207 208