/ 
OpenSearch-Client-3.007009
/ OpenSearch::Client::Core::3_0::Direct::RemoteStore

NAME

OpenSearch::Client::Core::3_0::Direct::RemoteStore

VERSION

version 3.007009

SYNOPSIS

use OpenSearch::Client;

my $client = OpenSearch::Client->new( ... );

my $response = $client->remote_store-><methodname>(
  valone => $value1,
  valtwo => $value2
);

DESCRIPTION

Restoring from a backup

Remote-backed storage offers OpenSearch users a new way to protect against data loss by automatically creating backups of all index transactions and sending them to remote storage.

See OpenSearch documentation for remote_store.

METHODS

restore

Restores from remote store.

Paths served by this method:

POST /_remotestore/_restore

Method added in OpenSearch version 1.0

$resp = $client->remote_store->restore(
    
    'body'                     =>  $body,      # optional
    
     # Endpoint specific query string parameters
    
    'cluster_manager_timeout'  =>  $qval1,     # string
    'wait_for_completion'      =>  $qval2,     # boolean
    
     # Common API query string parameters
    
    'error_trace'              =>  $qval3,     # boolean
    'filter_path'              =>  $qval4,     # list
    'human'                    =>  $qval5,     # boolean
    'pretty'                   =>  $qval6,     # boolean
    'source'                   =>  $qval7,     # string
);

OpenSearch documentation for remote_store->restore

method_supported_in_version

Return whether a method in this module namespace is supported for an OpenSearch server version

my $boolean = $os->remote_store->method_supported_in_version(
    method  => 'restore',
    version => '2.4.0'
);

Both method and version are required.

See also global_method_supported_in_version

MANUAL

Documentation index OpenSearch::Client::Manual

HISTORY

This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.

AUTHOR

Mark Dootson <mdootson@cpan.org> ( current maintainer )

CREDITS

OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.

COPYRIGHT AND LICENSE

Copyright (C) 2026 by Mark Dootson ( this distribution )

Copyright (C) 2021 by Elasticsearch BV ( original distribution )

This is free software, licensed under:

The Apache License, Version 2.0, January 2004