.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Search::Elasticsearch::Client::8_0::Direct::Snapshot 3pm"
.TH Search::Elasticsearch::Client::8_0::Direct::Snapshot 3pm 2024-02-04 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Search::Elasticsearch::Client::8_0::Direct::Snapshot \- A client for managing snapshot/restore
.SH VERSION
.IX Header "VERSION"
version 8.12
.SH DESCRIPTION
.IX Header "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.
.PP
It does Search::Elasticsearch::Role::Client::Direct.
.SH METHODS
.IX Header "METHODS"
.ie n .SS create_repository()
.el .SS \f(CWcreate_repository()\fP
.IX Subsection "create_repository()"
.Vb 4
\&    $e\->snapshot\->create_repository(
\&        repository  => \*(Aqrepository\*(Aq,        # required
\&        body        => { defn }             # required
\&    );
.Ve
.PP
Create a repository for backups.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR,
    \f(CW\*(C`timeout\*(C'\fR,
    \f(CW\*(C`verify\*(C'\fR
.PP
See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
.ie n .SS get_repository()
.el .SS \f(CWget_repository()\fP
.IX Subsection "get_repository()"
.Vb 3
\&    $e\->snapshot\->get_repository(
\&        repository  => \*(Aqrepository\*(Aq | \e@repositories    # optional
\&    );
.Ve
.PP
Retrieve existing repositories.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`local\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR
.PP
See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
.ie n .SS verify_repository()
.el .SS \f(CWverify_repository()\fP
.IX Subsection "verify_repository()"
.Vb 3
\&    $e\->snapshot\->verify_repository(
\&        repository  => \*(Aqrepository\*(Aq # required
\&    );
.Ve
.PP
Verify existing repository.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR,
    \f(CW\*(C`timeout\*(C'\fR
.PP
See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
.ie n .SS delete_repository()
.el .SS \f(CWdelete_repository()\fP
.IX Subsection "delete_repository()"
.Vb 3
\&    $e\->snapshot\->delete_repository(
\&        repository  => \*(Aqrepository\*(Aq | \e@repositories    # required
\&    );
.Ve
.PP
Delete repositories by name.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR,
    \f(CW\*(C`timeout\*(C'\fR
.PP
See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
.ie n .SS create()
.el .SS \f(CWcreate()\fP
.IX Subsection "create()"
.Vb 3
\&    $e\->snapshot\->create(
\&        repository  => \*(Aqrepository\*(Aq,     # required
\&        snapshot    => \*(Aqsnapshot\*(Aq,       # required,
\&
\&        body        => { snapshot defn } # optional
\&    );
.Ve
.PP
Create a snapshot of the whole cluster or individual indices in the named
repository.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR,
    \f(CW\*(C`wait_for_completion\*(C'\fR
.ie n .SS get()
.el .SS \f(CWget()\fP
.IX Subsection "get()"
.Vb 4
\&    $e\->snapshot\->get(
\&        repository  => \*(Aqrepository\*(Aq                   # required
\&        snapshot    => \*(Aqsnapshot\*(Aq   | \e@snapshots     # required
\&    );
.Ve
.PP
Retrieve snapshots in the named repository.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`ignore_unavailable\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR,
    \f(CW\*(C`verbose\*(C'\fR
.PP
See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
.ie n .SS delete()
.el .SS \f(CWdelete()\fP
.IX Subsection "delete()"
.Vb 4
\&    $e\->snapshot\->delete(
\&        repository  => \*(Aqrepository\*(Aq,              # required
\&        snapshot    => \*(Aqsnapshot\*(Aq                 # required
\&    );
.Ve
.PP
Delete snapshot in the named repository.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR
.PP
See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
.ie n .SS restore()
.el .SS \f(CWrestore()\fP
.IX Subsection "restore()"
.Vb 3
\&    $e\->snapshot\->restore(
\&        repository  => \*(Aqrepository\*(Aq,              # required
\&        snapshot    => \*(Aqsnapshot\*(Aq                 # required
\&
\&        body        => { what to restore }        # optional
\&    );
.Ve
.PP
Restore a named snapshot.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR,
    \f(CW\*(C`wait_for_completion\*(C'\fR
.PP
See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
.ie n .SS status()
.el .SS \f(CWstatus()\fP
.IX Subsection "status()"
.Vb 4
\&    $result = $e\->snapshot\->status(
\&        repository  => \*(Aqrepository\*(Aq,              # optional
\&        snapshot    => \*(Aqsnapshot\*(Aq | \e@snapshots   # optional
\&    );
.Ve
.PP
Returns status information about the specified snapshots.
.PP
Query string parameters:
    \f(CW\*(C`error_trace\*(C'\fR,
    \f(CW\*(C`human\*(C'\fR,
    \f(CW\*(C`ignore_unavailable\*(C'\fR,
    \f(CW\*(C`master_timeout\*(C'\fR
.PP
See the "snapshot/restore docs" <http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshot.html>
for more information.
.SH AUTHOR
.IX Header "AUTHOR"
Enrico Zimuel <enrico.zimuel@elastic.co>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2024 by Elasticsearch BV.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Apache License, Version 2.0, January 2004
.Ve