ldoc

• Index

Contents

• Methods

Classes

• Cat
• Client
• Cluster
• Indices
• Nodes
• Snapshot
• Tasks

Modules

• elasticsearch
• helper

Class Snapshot

The Snapshot class

Info:

• Author: Dhaval Kapil

Methods

Snapshot:createRepository (params)	Create Repository function
Snapshot:deleteRepository (params)	Delete Repository function
Snapshot:getRepository (params)	Get Repository function
Snapshot:create (params)	Create function
Snapshot:delete (params)	Delete function
Snapshot:get (params)	Get function
Snapshot:restore (params)	Restore function
Snapshot:status (params)	Status function
Snapshot:verifyRepository (params)	Verify Repository function

Methods

Snapshot:createRepository (params)

Create Repository function

Parameters:

• params

  The createRepository Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["repository"]     = (string) A repository name (Required)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["timeout"]        = (time) Explicit operation timeout
       ["verify"]         = (boolean) Whether to verify the repository after creation
       ["body"]           = The repository definition

Snapshot:deleteRepository (params)

Delete Repository function

Parameters:

• params

  The deleteRepository Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["repository"]     = (list) A comma-separated list of repository names (Required)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["timeout"]        = (time) Explicit operation timeout

Snapshot:getRepository (params)

Get Repository function

Parameters:

• params

  The getRepository Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["repository"]     = (list) A comma-separated list of repository names
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)

Snapshot:create (params)

Create function

Parameters:

• params

  The create Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["repository"]          = (string) A repository name (Required)
       ["snapshot"]            = (string) A snapshot name (Required)
       ["master_timeout"]      = (time) Explicit operation timeout for connection to master node
       ["wait_for_completion"] = (boolean) Should this request wait until the operation has completed before
       returning (default: false)
       ["body"]                = The snapshot definition

Snapshot:delete (params)

Delete function

Parameters:

• params

  The delete Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["repository"]     = (string) A repository name (Required)
       ["snapshot"]       = (string) A snapshot name (Required)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node

Snapshot:get (params)

Get function

Parameters:

• params

  The get Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["repository"]     = (string) A repository name (Required)
       ["snapshot"]       = (string) A snapshot name (Required)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node

Snapshot:restore (params)

Restore function

Parameters:

• params

  The restore Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["repository"]          = (string) A repository name (Required)
       ["snapshot"]            = (string) A snapshot name (Required)
       ["master_timeout"]      = (time) Explicit operation timeout for connection to master node
       ["wait_for_completion"] = (boolean) Should this request wait until the operation has completed before
       returning (default: false)
       ["body"]                = Details of what to restore

Snapshot:status (params)

Status function

Parameters:

• params

  The status Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["repository"]     = (string) A repository name
       ["snapshot"]       = (list) A comma-separated list of snapshot names
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node

Snapshot:verifyRepository (params)

Verify Repository function

Parameters:

• params

  The verify repository Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["repository"]     = (string) A repository name (Required)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["timeout"]        = (time) Explicit operation timeout