Module: Hyperb::Snapshots

Includes:

Utils

Included in:

API

Defined in:

lib/hyperb/snapshots/snapshots.rb

Overview

snapshots api wrapper

Instance Method Summary

• #create_snapshot(params = {}) ⇒ Hash

  create a snapshot.

Methods included from Utils

#camelize, #check_arguments, #downcase_symbolize, #prepare_json, #underscore

Instance Method Details

#create_snapshot(params = {}) ⇒ Hash

create a snapshot

Parameters:

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

  A customizable set of params.

Options Hash (params):

• :volume (String) —

  volume id

• :name (String) —

  snapshot’s name

Returns:

• (Hash) —

  symbolized json response.

Raises:

• (Hyperb::Error::Unauthorized) —

  raised when credentials are not valid.

• (Hyperb::Error::InternalServerError) —

  server error on hyper side.

• (Hyperb::Error::NotFound) —

  raised when volume is not found.

• (ArgumentError) —

  when required arguments are not provided.

See Also:

• https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Snapshot/create.html

# File 'lib/hyperb/snapshots/snapshots.rb', line 29

def create_snapshot(params = {})
  raise ArgumentError, 'Invalid arguments.' unless check_arguments(params, 'name', 'volume')
  path = '/snapshots/create'
  query = {}
  query[:name] = params[:name] if params.key?(:name)
  query[:volume] = params[:volume] if params.key?(:volume)
  res = JSON.parse(Hyperb::Request.new(self, path, query, 'post').perform)
  downcase_symbolize(res)
end