module BackendApi::Network
Public Instance Methods
Instantiates a new network instance from Occi::Infrastructure::Network. 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
network = Occi::Infrastructure::Network.new network_id = network_create(network) #=> "65d4f65adfadf-ad2f4ad-daf5ad-f5ad4fad4ffdf"
@param network [Occi::Infrastructure::Network] network instance containing necessary attributes @return [String] final identifier of the new network instance
# File app/models/backend_api/network.rb, line 67 def network_create(network) fail Errors::ArgumentError, '\'network\' is a mandatory argument' if network.blank? fail Errors::ArgumentTypeMismatchError, 'Action requires a network instance!' unless network.kind_of? Occi::Infrastructure::Network @backend_instance.network_create(deep_clone(network)) end
Deletes a specific network 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
network_delete("65d4f65adfadf-ad2f4ad-daf5ad-f5ad4fad4ffdf") #=> true
@param network_id [String] an identifier of a network instance to be deleted @return [true, false] result of the operation
# File app/models/backend_api/network.rb, line 102 def network_delete(network_id) fail Errors::ArgumentError, '\'network_id\' is a mandatory argument' if network_id.blank? @backend_instance.network_delete(network_id) end
Deletes all network 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
network_delete_all #=> true mixins = Occi::Core::Mixins.new << Occi::Core::Mixin.new network_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/network.rb, line 86 def network_delete_all(mixins = nil) mixins = deep_clone(mixins) if mixins @backend_instance.network_delete_all(mixins) end
Gets a specific network instance as Occi::Infrastructure::Network. ID given as an argument must match the occi.core.id attribute inside the returned Occi::Infrastructure::Network instance, however it is possible to implement internal mapping to a platform-specific identifier.
@example
network = network_get('65d4f65adfadf-ad2f4ad-daf5ad-f5ad4fad4ffdf') #=> #<Occi::Infrastructure::Network>
@param network_id [String] OCCI identifier of the requested network instance @return [Occi::Infrastructure::Network, nil] a network instance or `nil`
# File app/models/backend_api/network.rb, line 49 def network_get(network_id) fail Errors::ArgumentError, '\'network_id\' is a mandatory argument' if network_id.blank? @backend_instance.network_get(network_id) end
Gets all network 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::Network instances wrapped in Occi::Core::Resources.
@example
networks = network_list #=> #<Occi::Core::Resources> networks.first #=> #<Occi::Infrastructure::Network> mixins = Occi::Core::Mixins.new << Occi::Core::Mixin.new networks = network_list(mixins) #=> #<Occi::Core::Resources>
@param mixins [Occi::Core::Mixins] a filter containing mixins @return [Occi::Core::Resources] a collection of network instances
# File app/models/backend_api/network.rb, line 33 def network_list(mixins = nil) mixins = deep_clone(mixins) if mixins @backend_instance.network_list(mixins) || Occi::Core::Resources.new end
Gets all network instance IDs, no details, no duplicates. Returned identifiers must correspond to those found in the occi.core.id attribute of Occi::Infrastructure::Network instances.
@example
network_list_ids #=> [] network_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 network instances
# File app/models/backend_api/network.rb, line 14 def network_list_ids(mixins = nil) mixins = deep_clone(mixins) if mixins @backend_instance.network_list_ids(mixins) || [] end
Partially updates an existing network instance, instance to be updated is specified by network_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 network_partial_update(network_id, attributes, mixins, links) #=> true
@param network_id [String] unique identifier of a network 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/network.rb, line 123 def network_partial_update(network_id, attributes = nil, mixins = nil, links = nil) fail Errors::ArgumentError, '\'network_id\' is a mandatory argument' if network_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.network_partial_update(network_id, deep_clone(attributes), deep_clone(mixins), deep_clone(links)) end
Triggers an action on an existing network instance, the network instance in question is identified by a network 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 network_trigger_action("65d4f65adfadf-ad2f4ad-daf5ad-f5ad4fad4ffdf", action_instance) #=> true
@param network_id [String] network instance identifier @param action_instance [Occi::Core::ActionInstance] action to be triggered @return [true, false] result of the operation
# File app/models/backend_api/network.rb, line 188 def network_trigger_action(network_id, action_instance) fail Errors::ArgumentError, '\'network_id\' is a mandatory argument' if network_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.network_trigger_action(network_id, deep_clone(action_instance)) end
Triggers an action on all existing network 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 network_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/network.rb, line 167 def network_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.network_trigger_action_on_all(deep_clone(action_instance), mixins) end
Updates an existing network 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
network = Occi::Infrastructure::Network.new network_update(network) #=> true
@param network [Occi::Infrastructure::Network] instance containing updated information @return [true, false] result of the operation
# File app/models/backend_api/network.rb, line 147 def network_update(network) fail Errors::ArgumentError, '\'network\' is a mandatory argument' if network.blank? fail Errors::ArgumentTypeMismatchError, 'Action requires a network instance!' unless network.kind_of? Occi::Infrastructure::Network @backend_instance.network_update(deep_clone(network)) end