1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
# Licensed to Elasticsearch B.V under one or more agreements.
# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
# See the LICENSE file in the project root for more information
package Search::Elasticsearch::Client::8_0::Direct::Snapshot;
$Search::Elasticsearch::Client::8_0::Direct::Snapshot::VERSION = '8.12';
use Moo;
with 'Search::Elasticsearch::Client::8_0::Role::API';
with 'Search::Elasticsearch::Role::Client::Direct';
__PACKAGE__->_install_api('snapshot');
1;
=pod
=encoding UTF-8
=head1 NAME
Search::Elasticsearch::Client::8_0::Direct::Snapshot - A client for managing snapshot/restore
=head1 VERSION
version 8.12
=head1 DESCRIPTION
This module provides methods to manage snapshot/restore, or backups.
It can create, get and delete configured backup repositories, and
create, get, delete and restore snapshots of your cluster or indices.
It does L<Search::Elasticsearch::Role::Client::Direct>.
=head1 METHODS
=head2 C<create_repository()>
$e->snapshot->create_repository(
repository => 'repository', # required
body => { defn } # required
);
Create a repository for backups.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>,
C<timeout>,
C<verify>
See the L<"snapshot/restore docs"|http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
=head2 C<get_repository()>
$e->snapshot->get_repository(
repository => 'repository' | \@repositories # optional
);
Retrieve existing repositories.
Query string parameters:
C<error_trace>,
C<human>,
C<local>,
C<master_timeout>
See the L<"snapshot/restore docs"|http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
=head2 C<verify_repository()>
$e->snapshot->verify_repository(
repository => 'repository' # required
);
Verify existing repository.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>,
C<timeout>
See the L<"snapshot/restore docs"|http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
=head2 C<delete_repository()>
$e->snapshot->delete_repository(
repository => 'repository' | \@repositories # required
);
Delete repositories by name.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>,
C<timeout>
See the L<"snapshot/restore docs"|http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
=head2 C<create()>
$e->snapshot->create(
repository => 'repository', # required
snapshot => 'snapshot', # required,
body => { snapshot defn } # optional
);
Create a snapshot of the whole cluster or individual indices in the named
repository.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>,
C<wait_for_completion>
=head2 C<get()>
$e->snapshot->get(
repository => 'repository' # required
snapshot => 'snapshot' | \@snapshots # required
);
Retrieve snapshots in the named repository.
Query string parameters:
C<error_trace>,
C<human>,
C<ignore_unavailable>,
C<master_timeout>,
C<verbose>
See the L<"snapshot/restore docs"|http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
=head2 C<delete()>
$e->snapshot->delete(
repository => 'repository', # required
snapshot => 'snapshot' # required
);
Delete snapshot in the named repository.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>
See the L<"snapshot/restore docs"|http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
=head2 C<restore()>
$e->snapshot->restore(
repository => 'repository', # required
snapshot => 'snapshot' # required
body => { what to restore } # optional
);
Restore a named snapshot.
Query string parameters:
C<error_trace>,
C<human>,
C<master_timeout>,
C<wait_for_completion>
See the L<"snapshot/restore docs"|http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
=head2 C<status()>
$result = $e->snapshot->status(
repository => 'repository', # optional
snapshot => 'snapshot' | \@snapshots # optional
);
Returns status information about the specified snapshots.
Query string parameters:
C<error_trace>,
C<human>,
C<ignore_unavailable>,
C<master_timeout>
See the L<"snapshot/restore docs"|http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
=head1 AUTHOR
Enrico Zimuel <enrico.zimuel@elastic.co>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2024 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
__END__
# ABSTRACT: A client for managing snapshot/restore
|
