Rubber

v0.9.0

Rubber v0.9.0 Rubber.Snapshot.Snapshot

Functions for working with snapshots.

Elastic documentation

Link to this section Summary

Functions

create(elastic_url, repo_name, snapshot_name, data \\ %{}, query_params \\ [])

Creates a snapshot

delete(elastic_url, repo_name, snapshot_name)

Deletes a snapshot from a repository. This can also be used to stop currently running snapshot and restore operations

get(elastic_url, repo_name \\ "", snapshot_name \\ "_all")

If repo_name and snapshot_name is specified, will retrieve information about that snapshot. If repo_name is specified, will retrieve information about all snapshots in that repository. Oterwise, will retrieve information about all snapshots

restore(elastic_url, repo_name, snapshot_name, data \\ %{})

Restores a previously created snapshot

status(elastic_url, repo_name \\ "", snapshot_name \\ "")

If repo_name and snapshot_name is specified, will retrieve the status of that snapsot. If repo_name is specified, will retrieve the status of all snapshots in that repository. Otherwise, will retrieve the status of all snapshots

Link to this section Functions

Link to this function create(elastic_url, repo_name, snapshot_name, data \\ %{}, query_params \\ []) 
create(String.t(), String.t(), String.t(), Map.t(), [tuple()]) ::
  {:ok,
   %HTTPoison.Response{
     body: term(),
     headers: term(),
     request_url: term(),
     status_code: term()
   }}

Creates a snapshot.

Link to this function delete(elastic_url, repo_name, snapshot_name) 
delete(String.t(), String.t(), String.t()) ::
  {:ok,
   %HTTPoison.Response{
     body: term(),
     headers: term(),
     request_url: term(),
     status_code: term()
   }}

Deletes a snapshot from a repository. This can also be used to stop currently running snapshot and restore operations.

Link to this function get(elastic_url, repo_name \\ "", snapshot_name \\ "_all") 
get(String.t(), String.t(), String.t()) ::
  {:ok,
   %HTTPoison.Response{
     body: term(),
     headers: term(),
     request_url: term(),
     status_code: term()
   }}

If repo_name and snapshot_name is specified, will retrieve information about that snapshot. If repo_name is specified, will retrieve information about all snapshots in that repository. Oterwise, will retrieve information about all snapshots.

Link to this function restore(elastic_url, repo_name, snapshot_name, data \\ %{}) 
restore(String.t(), String.t(), String.t(), Map.t()) ::
  {:ok,
   %HTTPoison.Response{
     body: term(),
     headers: term(),
     request_url: term(),
     status_code: term()
   }}

Restores a previously created snapshot.

Link to this function status(elastic_url, repo_name \\ "", snapshot_name \\ "") 
status(String.t(), String.t(), String.t()) ::
  {:ok,
   %HTTPoison.Response{
     body: term(),
     headers: term(),
     request_url: term(),
     status_code: term()
   }}

If repo_name and snapshot_name is specified, will retrieve the status of that snapsot. If repo_name is specified, will retrieve the status of all snapshots in that repository. Otherwise, will retrieve the status of all snapshots.