Elastix.Snapshot.Repository (Elastix v0.10.0) View Source

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

Link to this section Summary

Functions

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

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

Registers a repository.

verify(elastic_url, repo_name)

Verifies a registered but unverified repository.

Link to this section Functions

delete(elastic_url, repo_name)

Specs

delete(String.t(), String.t()) ::
  {:ok,
   %HTTPoison.Response{
     body: term(),
     headers: term(),
     request: term(),
     request_url: term(),
     status_code: term()
   }}

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

get(elastic_url, repo_name \\ "_all")

Specs

get(String.t(), String.t()) ::
  {:ok,
   %HTTPoison.Response{
     body: term(),
     headers: term(),
     request: 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.

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

Specs

register(String.t(), String.t(), Map.t(), [tuple()]) ::
  {:ok,
   %HTTPoison.Response{
     body: term(),
     headers: term(),
     request: term(),
     request_url: term(),
     status_code: term()
   }}

Registers a repository.

verify(elastic_url, repo_name)

Specs

verify(String.t(), String.t()) ::
  {:ok,
   %HTTPoison.Response{
     body: term(),
     headers: term(),
     request: term(),
     request_url: term(),
     status_code: term()
   }}

Verifies a registered but unverified repository.