Methods
(static) SnapshotApi#cleanupRepository(params, options, callback) → {Object|Promise.<never>|*}
Removes stale data from repository.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
|
A repository name |
cluster_manager_timeout |
string
|
<optional>
|
Explicit operation timeout for connection to cluster_manager node |
timeout |
string
|
<optional>
|
Explicit operation timeout |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#clone(params, options, callback) → {Object|Promise.<never>|*}
Clones indices from one snapshot into another snapshot in the same repository.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
|
A repository name |
snapshot |
string
|
|
The name of the snapshot to clone from |
body |
Object
|
|
The snapshot clone definition |
target_snapshot |
string
|
<optional>
|
The name of the cloned snapshot to create |
cluster_manager_timeout |
string
|
<optional>
|
Explicit operation timeout for connection to cluster_manager node |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#create(params, options, callback) → {Object|Promise.<never>|*}
Creates a snapshot in a repository.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
|
A repository name |
snapshot |
string
|
|
A snapshot name |
cluster_manager_timeout |
string
|
<optional>
|
Explicit operation timeout for connection to cluster_manager node |
wait_for_completion |
boolean
|
<optional>
|
Should this request wait until the operation has completed before returning |
body |
Object
|
<optional>
|
The snapshot definition |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#createRepository(params, options, callback) → {Object|Promise.<never>|*}
Creates a repository.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
|
A repository name |
body |
Object
|
|
The repository definition |
cluster_manager_timeout |
string
|
<optional>
|
Explicit operation timeout for connection to cluster_manager node |
timeout |
string
|
<optional>
|
Explicit operation timeout |
verify |
boolean
|
<optional>
|
Whether to verify the repository after creation |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#delete(params, options, callback) → {Object|Promise.<never>|*}
Deletes a snapshot.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
<optional>
|
A repository name |
snapshot |
string
|
<optional>
|
A snapshot name |
master_timeout |
string
|
<optional>
|
(DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node |
cluster_manager_timeout |
string
|
<optional>
|
Explicit operation timeout for connection to cluster_manager node |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#deleteRepository(params, options, callback) → {Object|Promise.<never>|*}
Deletes a repository.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
<optional>
|
Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. |
master_timeout |
string
|
<optional>
|
(DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node |
cluster_manager_timeout |
string
|
<optional>
|
Explicit operation timeout for connection to cluster_manager node |
timeout |
string
|
<optional>
|
Explicit operation timeout |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#get(params, options, callback) → {Object|Promise.<never>|*}
Returns information about a snapshot.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
<optional>
|
A repository name |
snapshot |
string
|
<optional>
|
A comma-separated list of snapshot names |
master_timeout |
string
|
<optional>
|
(DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node |
cluster_manager_timeout |
string
|
<optional>
|
Explicit operation timeout for connection to cluster_manager node |
ignore_unavailable |
boolean
|
<optional>
|
Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown |
index_details |
boolean
|
<optional>
|
Whether to include details of each index in the snapshot, if those details are available. Defaults to false. |
include_repository |
boolean
|
<optional>
|
Whether to include the repository name in the snapshot info. Defaults to true. |
verbose |
boolean
|
<optional>
|
Whether to show verbose snapshot info or only show the basic info found in the repository index blob |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#getRepository(params, options, callback) → {Object|Promise.<never>|*}
Returns information about a snapshot.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
<optional>
|
A comma-separated list of repository names |
master_timeout |
string
|
<optional>
|
(DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to cluster_manager node |
local |
boolean
|
<optional>
|
Return local information, do not retrieve the state from cluster_manager node (default: false) |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#repositoryAnalyze(params, options, callback) → {Object|Promise.<never>|*}
Analyzes a repository for correctness and performance
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
<optional>
|
A repository name |
blob_count |
number
|
<optional>
|
Number of blobs to create during the test. Defaults to 100. |
concurrency |
number
|
<optional>
|
Number of operations to run concurrently during the test. Defaults to 10. |
read_node_count |
number
|
<optional>
|
Number of nodes on which to read a blob after writing. Defaults to 10. |
early_read_node_count |
number
|
<optional>
|
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. |
seed |
number
|
<optional>
|
Seed for the random number generator used to create the test workload. Defaults to a random value. |
rare_action_probability |
number
|
<optional>
|
Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02. |
max_blob_size |
string
|
<optional>
|
Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'. |
max_total_data_size |
string
|
<optional>
|
Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'. |
timeout |
string
|
<optional>
|
Explicit operation timeout. Defaults to '30s'. |
detailed |
boolean
|
<optional>
|
Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned. |
rarely_abort_writes |
boolean
|
<optional>
|
Whether to rarely abort writes before they complete. Defaults to 'true'. |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#restore(params, options, callback) → {Object|Promise.<never>|*}
Restores a snapshot.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
<optional>
|
A repository name |
snapshot |
string
|
<optional>
|
A snapshot name |
master_timeout |
string
|
<optional>
|
(DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node |
cluster_manager_timeout |
string
|
<optional>
|
Explicit operation timeout for connection to cluster_manager node |
wait_for_completion |
boolean
|
<optional>
|
Should this request wait until the operation has completed before returning |
body |
Object
|
<optional>
|
Details of what to restore |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#status(params, options, callback) → {Object|Promise.<never>|*}
Returns information about the status of a snapshot.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
<optional>
|
A repository name |
snapshot |
string
|
<optional>
|
A comma-separated list of snapshot names |
master_timeout |
string
|
<optional>
|
(DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node |
cluster_manager_timeout |
string
|
<optional>
|
Explicit operation timeout for connection to cluster_manager node |
ignore_unavailable |
boolean
|
<optional>
|
Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*
(static) SnapshotApi#verifyRepository(params, options, callback) → {Object|Promise.<never>|*}
Verifies a repository.
Parameters:
| Name |
Type |
Description |
params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
repository |
string
|
<optional>
|
A repository name |
master_timeout |
string
|
<optional>
|
(DEPRECATED: use cluster_manager_timeout instead) Explicit operation timeout for connection to master node |
cluster_manager_timeout |
string
|
<optional>
|
Explicit operation timeout for connection to cluster_manager node |
timeout |
string
|
<optional>
|
Explicit operation timeout |
|
options |
Object
|
Options for Transport#request |
callback |
function
|
Callback that handles errors and response |
- Source:
Returns:
-
Type
-
Object
|
Promise.<never>
|
*