Debian Codegraph @

lib/Search/Elasticsearch/Client/8_0/Direct/Snapshot.pm

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