Method: Elasticsearch::API::Snapshot::Actions#create

Defined in:
lib/elasticsearch/api/actions/snapshot/create.rb

#create(arguments = {}) ⇒ Object

Creates a snapshot in a repository.

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :repository (String) —

    A repository name

  • :snapshot (String) —

    A snapshot name

  • :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

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The snapshot definition

Raises:

  • (ArgumentError)

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/elasticsearch/api/actions/snapshot/create.rb', line 36

def create(arguments = {})
  request_opts = { endpoint: arguments[:endpoint] || "snapshot.create" }

  defined_params = [:repository, :snapshot].inject({}) do |set_variables, variable|
    set_variables[variable] = arguments[variable] if arguments.key?(variable)
    set_variables
  end
  request_opts[:defined_params] = defined_params unless defined_params.empty?

  raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
  raise ArgumentError, "Required argument 'snapshot' missing" unless arguments[:snapshot]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body = arguments.delete(:body)

  _repository = arguments.delete(:repository)

  _snapshot = arguments.delete(:snapshot)

  method = Elasticsearch::API::HTTP_PUT
  path   = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers, request_opts)
  )
end