IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elasticsearch\Namespaces\RemoteNamespace Elasticsearch\Namespaces\TasksNamespace »
Elastic Docs ›Elasticsearch-PHP [6.x] ›Reference - Endpoints

Elasticsearch\Namespaces\SnapshotNamespace

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Elasticsearch\Namespaces\SnapshotNamespace

edit

Class SnapshotNamespace

Methods

The class defines the following methods:

create()

/*
$params['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['wait_for_completion'] = (bool) Should this request wait until the operation has completed before returning
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->snapshot()->create($params);

createRepository()

/*
$params['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['timeout'] = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->snapshot()->createRepository($params);

delete()

/*
$params['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->snapshot()->delete($params);

deleteRepository()

/*
$params['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['timeout'] = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->snapshot()->deleteRepository($params);

get()

/*
$params['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->snapshot()->get($params);

getRepository()

/*
$params['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['timeout'] = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->snapshot()->getRepository($params);

restore()

/*
$params['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['wait_for_completion'] = (bool) Should this request wait until the operation has completed before returning
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->snapshot()->restore($params);

status()

/*
$params['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->snapshot()->status($params);

verifyRepository()

/*
$params['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['timeout'] = (time) Explicit operation timeout
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->snapshot()->verifyRepository($params);
« Elasticsearch\Namespaces\RemoteNamespace Elasticsearch\Namespaces\TasksNamespace »