module BackendApi::Storage

Public Instance Methods

storage_create(storage) click to toggle source

Instantiates a new storage instance from Occi::Infrastructure::Storage. ID given in the occi.core.id attribute is optional and can be changed inside this method. Final occi.core.id must be returned as a String. If the requested instance cannot be created, an error describing the problem must be raised, @see Backends::Errors.

@example

storage = Occi::Infrastructure::Storage.new
storage_id = storage_create(storage)
    #=> "65d4f65adfadf-ad2f4ad-daf5ad-f5ad4fad4ffdf"

@param storage [Occi::Infrastructure::Storage] storage instance containing necessary attributes @return [String] final identifier of the new storage instance

# File app/models/backend_api/storage.rb, line 67
def storage_create(storage)
  fail Errors::ArgumentError, '\'storage\' is a mandatory argument' if storage.blank?
  fail Errors::ArgumentTypeMismatchError, 'Action requires a storage instance!' unless storage.kind_of? Occi::Infrastructure::Storage
  @backend_instance.storage_create(deep_clone(storage))
end
storage_delete(storage_id) click to toggle source

Deletes a specific storage instance, instance to be deleted is specified by an ID, this ID must match the occi.core.id attribute of the deleted instance. If the requested instance cannot be deleted, an error describing the problem must be raised, @see Backends::Errors.

@example

storage_delete("65d4f65adfadf-ad2f4ad-daf5ad-f5ad4fad4ffdf") #=> true

@param storage_id [String] an identifier of a storage instance to be deleted @return [true, false] result of the operation

# File app/models/backend_api/storage.rb, line 102
def storage_delete(storage_id)
  fail Errors::ArgumentError, '\'storage_id\' is a mandatory argument' if storage_id.blank?
  @backend_instance.storage_delete(storage_id)
end
storage_delete_all(mixins = nil) click to toggle source

Deletes all storage instances, instances to be deleted must be filtered by the specified filter, filter (if set) must contain an Occi::Core::Mixins instance. If the requested instances cannot be deleted, an error describing the problem must be raised, @see Backends::Errors.

@example

storage_delete_all #=> true

mixins = Occi::Core::Mixins.new << Occi::Core::Mixin.new
storage_delete_all(mixins)  #=> true

@param mixins [Occi::Core::Mixins] a filter containing mixins @return [true, false] result of the operation

# File app/models/backend_api/storage.rb, line 86
def storage_delete_all(mixins = nil)
  mixins = deep_clone(mixins) if mixins
  @backend_instance.storage_delete_all(mixins)
end
storage_get(storage_id) click to toggle source

Gets a specific storage instance as Occi::Infrastructure::Storage. ID given as an argument must match the occi.core.id attribute inside the returned Occi::Infrastructure::Storage instance, however it is possible to implement internal mapping to a platform-specific identifier.

@example

storage = storage_get('65d4f65adfadf-ad2f4ad-daf5ad-f5ad4fad4ffdf')
    #=> #<Occi::Infrastructure::Storage>

@param storage_id [String] OCCI identifier of the requested storage instance @return [Occi::Infrastructure::Storage, nil] a storage instance or `nil`

# File app/models/backend_api/storage.rb, line 49
def storage_get(storage_id)
  fail Errors::ArgumentError, '\'storage_id\' is a mandatory argument' if storage_id.blank?
  @backend_instance.storage_get(storage_id)
end
storage_list(mixins = nil) click to toggle source

Gets all storage instances, instances must be filtered by the specified filter, filter (if set) must contain an Occi::Core::Mixins instance. Returned collection must contain Occi::Infrastructure::Storage instances wrapped in Occi::Core::Resources.

@example

storages = storage_list #=> #<Occi::Core::Resources>
storages.first #=> #<Occi::Infrastructure::Storage>

mixins = Occi::Core::Mixins.new << Occi::Core::Mixin.new
storages = storage_list(mixins) #=> #<Occi::Core::Resources>

@param mixins [Occi::Core::Mixins] a filter containing mixins @return [Occi::Core::Resources] a collection of storage instances

# File app/models/backend_api/storage.rb, line 33
def storage_list(mixins = nil)
  mixins = deep_clone(mixins) if mixins
  @backend_instance.storage_list(mixins) || Occi::Core::Resources.new
end
storage_list_ids(mixins = nil) click to toggle source

Gets all storage instance IDs, no details, no duplicates. Returned identifiers must correspond to those found in the occi.core.id attribute of Occi::Infrastructure::Storage instances.

@example

storage_list_ids #=> []
storage_list_ids #=> ["65d4f65adfadf-ad2f4ad-daf5ad-f5ad4fad4ffdf",
                         "ggf4f65adfadf-adgg4ad-daggad-fydd4fadyfdfd"]

@param mixins [Occi::Core::Mixins] a filter containing mixins @return [Array<String>] IDs for all available storage instances

# File app/models/backend_api/storage.rb, line 14
def storage_list_ids(mixins = nil)
  mixins = deep_clone(mixins) if mixins
  @backend_instance.storage_list_ids(mixins) || []
end
storage_partial_update(storage_id, attributes = nil, mixins = nil, links = nil) click to toggle source

Partially updates an existing storage instance, instance to be updated is specified by storage_id. If the requested instance cannot be updated, an error describing the problem must be raised, @see Backends::Errors.

@example

attributes = Occi::Core::Attributes.new
mixins = Occi::Core::Mixins.new
links = Occi::Core::Links.new
storage_partial_update(storage_id, attributes, mixins, links) #=> true

@param storage_id [String] unique identifier of a storage instance to be updated @param attributes [Occi::Core::Attributes] a collection of attributes to be updated @param mixins [Occi::Core::Mixins] a collection of mixins to be added @param links [Occi::Core::Links] a collection of links to be added @return [true, false] result of the operation

# File app/models/backend_api/storage.rb, line 123
def storage_partial_update(storage_id, attributes = nil, mixins = nil, links = nil)
  fail Errors::ArgumentError, '\'storage_id\' is a mandatory argument' if storage_id.blank?
  attributes ||= Occi::Core::Attributes.new
  mixins ||= Occi::Core::Mixins.new
  links ||= Occi::Core::Links.new

  unless attributes.kind_of?(Occi::Core::Attributes) && mixins.kind_of?(Occi::Core::Mixins) && links.kind_of?(Occi::Core::Links)
    fail Errors::ArgumentTypeMismatchError, 'Action requires attributes, mixins or links to be updated!'
  end

  @backend_instance.storage_partial_update(storage_id, deep_clone(attributes), deep_clone(mixins), deep_clone(links))
end
storage_trigger_action(storage_id, action_instance) click to toggle source

Triggers an action on an existing storage instance, the storage instance in question is identified by a storage instance ID, action is identified by the action.term attribute of the action instance passed as an argument. If the requested action cannot be triggered, an error describing the problem must be raised, @see Backends::Errors.

@example

action_instance = Occi::Core::ActionInstance.new
storage_trigger_action("65d4f65adfadf-ad2f4ad-daf5ad-f5ad4fad4ffdf", action_instance)
  #=> true

@param storage_id [String] storage instance identifier @param action_instance [Occi::Core::ActionInstance] action to be triggered @return [true, false] result of the operation

# File app/models/backend_api/storage.rb, line 187
def storage_trigger_action(storage_id, action_instance)
  fail Errors::ArgumentError, '\'storage_id\' is a mandatory argument' if storage_id.blank?
  fail Errors::ArgumentError, '\'action_instance\' is a mandatory argument' if action_instance.blank?
  fail Errors::ArgumentTypeMismatchError, 'Action requires an action instance!' unless action_instance.kind_of? Occi::Core::ActionInstance
  @backend_instance.storage_trigger_action(storage_id, deep_clone(action_instance))
end
storage_trigger_action_on_all(action_instance, mixins = nil) click to toggle source

Triggers an action on all existing storage instance, instances must be filtered by the specified filter, filter (if set) must contain an Occi::Core::Mixins instance, action is identified by the action.term attribute of the action instance passed as an argument. If the requested action cannot be triggered, an error describing the problem must be raised, @see Backends::Errors.

@example

action_instance = Occi::Core::ActionInstance.new
mixins = Occi::Core::Mixins.new << Occi::Core::Mixin.new
storage_trigger_action_on_all(action_instance, mixin) #=> true

@param action_instance [Occi::Core::ActionInstance] action to be triggered @param mixins [Occi::Core::Mixins] a filter containing mixins @return [true, false] result of the operation

# File app/models/backend_api/storage.rb, line 166
def storage_trigger_action_on_all(action_instance, mixins = nil)
  fail Errors::ArgumentError, '\'action_instance\' is a mandatory argument' if action_instance.blank?
  fail Errors::ArgumentTypeMismatchError, 'Action requires an action instance!' unless action_instance.kind_of? Occi::Core::ActionInstance
  mixins = deep_clone(mixins) if mixins
  @backend_instance.storage_trigger_action_on_all(deep_clone(action_instance), mixins)
end
storage_update(storage) click to toggle source

Updates an existing storage instance, instance to be updated is specified using the occi.core.id attribute of the instance passed as an argument. If the requested instance cannot be updated, an error describing the problem must be raised, @see Backends::Errors.

@example

storage = Occi::Infrastructure::Storage.new
storage_update(storage) #=> true

@param storage [Occi::Infrastructure::Storage] instance containing updated information @return [true, false] result of the operation

# File app/models/backend_api/storage.rb, line 147
def storage_update(storage)
  fail Errors::ArgumentError, '\'storage\' is a mandatory argument' if storage.blank?
  @backend_instance.storage_update(deep_clone(storage))
end