1Search::Elasticsearch::UCsSleeiraernCctoh:n::t:6rE_il0ba:us:ttDeiidcrsePeceatrr:lc:hSD:no:acCpulsmiheeonnttt(a:3t:)i6o_n0::Direct::Snapshot(3)
2
3
4
6 Search::Elasticsearch::Client::6_0::Direct::Snapshot - A client for
7 managing snapshot/restore
8
10 version 6.00
11
13 This module provides methods to manage snapshot/restore, or backups.
14 It can create, get and delete configured backup repositories, and
15 create, get, delete and restore snapshots of your cluster or indices.
16
17 It does Search::Elasticsearch::Role::Client::Direct.
18
20 "create_repository()"
21 $e->snapshot->create_repository(
22 repository => 'repository', # required
23 body => { defn } # required
24 );
25
26 Create a repository for backups.
27
28 Query string parameters:
29 "error_trace",
30 "human",
31 "master_timeout",
32 "timeout",
33 "verify"
34
35 See the "snapshot/restore docs"
36 <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-
37 snapshot.html> for more information.
38
39 "get_repository()"
40 $e->snapshot->get_repository(
41 repository => 'repository' | \@repositories # optional
42 );
43
44 Retrieve existing repositories.
45
46 Query string parameters:
47 "error_trace",
48 "human",
49 "local",
50 "master_timeout"
51
52 See the "snapshot/restore docs"
53 <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-
54 snapshot.html> for more information.
55
56 "verify_repository()"
57 $e->snapshot->verify_repository(
58 repository => 'repository' # required
59 );
60
61 Verify existing repository.
62
63 Query string parameters:
64 "error_trace",
65 "human",
66 "master_timeout",
67 "timeout"
68
69 See the "snapshot/restore docs"
70 <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-
71 snapshot.html> for more information.
72
73 "delete_repository()"
74 $e->snapshot->delete_repository(
75 repository => 'repository' | \@repositories # required
76 );
77
78 Delete repositories by name.
79
80 Query string parameters:
81 "error_trace",
82 "human",
83 "master_timeout",
84 "timeout"
85
86 See the "snapshot/restore docs"
87 <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-
88 snapshot.html> for more information.
89
90 "create()"
91 $e->snapshot->create(
92 repository => 'repository', # required
93 snapshot => 'snapshot', # required,
94
95 body => { snapshot defn } # optional
96 );
97
98 Create a snapshot of the whole cluster or individual indices in the
99 named repository.
100
101 Query string parameters:
102 "error_trace",
103 "human",
104 "master_timeout",
105 "wait_for_completion"
106
107 "get()"
108 $e->snapshot->get(
109 repository => 'repository' # required
110 snapshot => 'snapshot' | \@snapshots # required
111 );
112
113 Retrieve snapshots in the named repository.
114
115 Query string parameters:
116 "error_trace",
117 "human",
118 "ignore_unavailable",
119 "master_timeout",
120 "verbose"
121
122 See the "snapshot/restore docs"
123 <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-
124 snapshot.html> for more information.
125
126 "delete()"
127 $e->snapshot->delete(
128 repository => 'repository', # required
129 snapshot => 'snapshot' # required
130 );
131
132 Delete snapshot in the named repository.
133
134 Query string parameters:
135 "error_trace",
136 "human",
137 "master_timeout"
138
139 See the "snapshot/restore docs"
140 <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-
141 snapshot.html> for more information.
142
143 "restore()"
144 $e->snapshot->restore(
145 repository => 'repository', # required
146 snapshot => 'snapshot' # required
147
148 body => { what to restore } # optional
149 );
150
151 Restore a named snapshot.
152
153 Query string parameters:
154 "error_trace",
155 "human",
156 "master_timeout",
157 "wait_for_completion"
158
159 See the "snapshot/restore docs"
160 <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-
161 snapshot.html> for more information.
162
163 "status()"
164 $result = $e->snapshot->status(
165 repository => 'repository', # optional
166 snapshot => 'snapshot' | \@snapshots # optional
167 );
168
169 Returns status information about the specified snapshots.
170
171 Query string parameters:
172 "error_trace",
173 "human",
174 "ignore_unavailable",
175 "master_timeout"
176
177 See the "snapshot/restore docs"
178 <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-
179 snapshot.html> for more information.
180
182 Clinton Gormley <drtech@cpan.org>
183
185 This software is Copyright (c) 2017 by Elasticsearch BV.
186
187 This is free software, licensed under:
188
189 The Apache License, Version 2.0, January 2004
190
191
192
193perl v5.28.1 Search::Ela2s0t1i7c-s1e1a-r1c4h::Client::6_0::Direct::Snapshot(3)