Rubber

v0.9.0

Rubber v0.9.0 Rubber.Snapshot.Repository

Functions for working with repositories. A repository is required for taking and restoring snapshots of indices.

Elastic documentation

Link to this section Summary

Functions

delete(elastic_url, repo_name)

Removes the reference to the location where the snapshots are stored

get(elastic_url, repo_name \\ "_all")

If repo_name specified, will retrieve information about a registered repository. Otherwise, will retrieve information about all repositories

register(elastic_url, repo_name, data, query_params \\ [])

Registers a repository

verify(elastic_url, repo_name)

Verifies a registered but unverified repository

Link to this section Functions

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

Removes the reference to the location where the snapshots are stored.

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

If repo_name specified, will retrieve information about a registered repository. Otherwise, will retrieve information about all repositories.

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

Registers a repository.

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

Verifies a registered but unverified repository.