Lines Matching refs:params
33 * $params['repository'] = (string) A repository name
34 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
35 * $params['timeout'] = (time) Explicit operation timeout
37 * @param array $params Associative array of parameters
41 public function cleanupRepository(array $params = [])
43 $repository = $this->extractArgument($params, 'repository');
47 $endpoint->setParams($params);
55 * $params['repository'] = (string) A repository name
56 * $params['snapshot'] = (string) The name of the snapshot to clone from
57 * $params['target_snapshot'] = (string) The name of the cloned snapshot to create
58 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
59 * $params['body'] = (array) The snapshot clone definition (Required)
61 * @param array $params Associative array of parameters
65 public function clone(array $params = [])
67 $repository = $this->extractArgument($params, 'repository');
68 $snapshot = $this->extractArgument($params, 'snapshot');
69 $target_snapshot = $this->extractArgument($params, 'target_snapshot');
70 $body = $this->extractArgument($params, 'body');
74 $endpoint->setParams($params);
85 * $params['repository'] = (string) A repository name
86 * $params['snapshot'] = (string) A snapshot name
87 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
88 * $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning (Default = false)
89 * $params['body'] = (array) The snapshot definition
91 * @param array $params Associative array of parameters
95 public function create(array $params = [])
97 $repository = $this->extractArgument($params, 'repository');
98 $snapshot = $this->extractArgument($params, 'snapshot');
99 $body = $this->extractArgument($params, 'body');
103 $endpoint->setParams($params);
113 * $params['repository'] = (string) A repository name
114 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
115 * $params['timeout'] = (time) Explicit operation timeout
116 * $params['verify'] = (boolean) Whether to verify the repository after creation
117 * $params['body'] = (array) The repository definition (Required)
119 * @param array $params Associative array of parameters
123 public function createRepository(array $params = [])
125 $repository = $this->extractArgument($params, 'repository');
126 $body = $this->extractArgument($params, 'body');
130 $endpoint->setParams($params);
139 * $params['repository'] = (string) A repository name
140 * $params['snapshot'] = (string) A snapshot name
141 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
143 * @param array $params Associative array of parameters
147 public function delete(array $params = [])
149 $repository = $this->extractArgument($params, 'repository');
150 $snapshot = $this->extractArgument($params, 'snapshot');
154 $endpoint->setParams($params);
163 * $params['repository'] = (list) Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.
164 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
165 * $params['timeout'] = (time) Explicit operation timeout
167 * @param array $params Associative array of parameters
171 public function deleteRepository(array $params = [])
173 $repository = $this->extractArgument($params, 'repository');
177 $endpoint->setParams($params);
185 * $params['repository'] = (string) A repository name
186 * $params['snapshot'] = (list) A comma-separated list of snapshot names
187 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
188 * $params['ignore_unavailable'] = (boolean) Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
189 * $params['index_details'] = (boolean) Whether to include details of each index in the snapshot, if those details are available. Defaults to false.
190 * $params['include_repository'] = (boolean) Whether to include the repository name in the snapshot info. Defaults to true.
191 * $params['verbose'] = (boolean) Whether to show verbose snapshot info or only show the basic info found in the repository index blob
193 * @param array $params Associative array of parameters
197 public function get(array $params = [])
199 $repository = $this->extractArgument($params, 'repository');
200 $snapshot = $this->extractArgument($params, 'snapshot');
204 $endpoint->setParams($params);
213 * $params['repository'] = (list) A comma-separated list of repository names
214 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
215 * $params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false)
217 * @param array $params Associative array of parameters
221 public function getRepository(array $params = [])
223 $repository = $this->extractArgument($params, 'repository');
227 $endpoint->setParams($params);
235 * $params['repository'] = (string) A repository name
236 * $params['blob_count'] = (number) Number of blobs to create during the test. Defaults to 100.
237 * $params['concurrency'] = (number) Number of operations to run concurrently during the test. Defaults to 10.
238 * $params['read_node_count'] = (number) Number of nodes on which to read a blob after writing. Defaults to 10.
239 * $params['early_read_node_count'] = (number) Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2.
240 * $params['seed'] = (number) Seed for the random number generator used to create the test workload. Defaults to a random value.
241 * $params['rare_action_probability'] = (number) Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02.
242 * $params['max_blob_size'] = (string) Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'.
243 * $params['max_total_data_size'] = (string) Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'.
244 * $params['timeout'] = (time) Explicit operation timeout. Defaults to '30s'.
245 * $params['detailed'] = (boolean) Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned.
246 * $params['rarely_abort_writes'] = (boolean) Whether to rarely abort writes before they complete. Defaults to 'true'.
248 * @param array $params Associative array of parameters
252 public function repositoryAnalyze(array $params = [])
254 $repository = $this->extractArgument($params, 'repository');
258 $endpoint->setParams($params);
266 * $params['repository'] = (string) A repository name
267 * $params['snapshot'] = (string) A snapshot name
268 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
269 * $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning (Default = false)
270 * $params['body'] = (array) Details of what to restore
272 * @param array $params Associative array of parameters
276 public function restore(array $params = [])
278 $repository = $this->extractArgument($params, 'repository');
279 $snapshot = $this->extractArgument($params, 'snapshot');
280 $body = $this->extractArgument($params, 'body');
284 $endpoint->setParams($params);
294 * $params['repository'] = (string) A repository name
295 * $params['snapshot'] = (list) A comma-separated list of snapshot names
296 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
297 * $params['ignore_unavailable'] = (boolean) Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown
299 * @param array $params Associative array of parameters
303 public function status(array $params = [])
305 $repository = $this->extractArgument($params, 'repository');
306 $snapshot = $this->extractArgument($params, 'snapshot');
310 $endpoint->setParams($params);
319 * $params['repository'] = (string) A repository name
320 * $params['master_timeout'] = (time) Explicit operation timeout for connection to master node
321 * $params['timeout'] = (time) Explicit operation timeout
323 * @param array $params Associative array of parameters
327 public function verifyRepository(array $params = [])
329 $repository = $this->extractArgument($params, 'repository');
333 $endpoint->setParams($params);