You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltacloud.apache.org by mf...@apache.org on 2013/03/26 18:58:07 UTC
[21/30] Client: removed doc/* directory
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/71afec55/client/doc/deltacloud.rb
----------------------------------------------------------------------
diff --git a/client/doc/deltacloud.rb b/client/doc/deltacloud.rb
deleted file mode 100644
index b2a2c9a..0000000
--- a/client/doc/deltacloud.rb
+++ /dev/null
@@ -1,1387 +0,0 @@
-module DeltaCloud
- class API
-# Return InstanceState object with given id
-
-#
-# The possible states of an instance, and how to traverse between them
-# @return [InstanceState]
-def instance_state
-end
-# Return collection of InstanceState objects
-#
-# The possible states of an instance, and how to traverse between them
-# @return [Array] [InstanceState]
-def instance_states(opts={})
-end
-# Return StorageVolume object with given id
-
-#
-# Storage volumes description here
-# @return [StorageVolume]
-def storage_volume
-end
-# Return collection of StorageVolume objects
-#
-# Storage volumes description here
- # @param [string, id]
-# @return [Array] [StorageVolume]
-def storage_volumes(opts={})
-end
-# Return Instance object with given id
-
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
-# @return [Instance]
-def instance
-end
-# Return collection of Instance objects
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
- # @param [string, state]
- # @param [string, id]
-# @return [Array] [Instance]
-def instances(opts={})
-end
-# Return HardwareProfile object with given id
-
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
-# @return [HardwareProfile]
-def hardware_profile
-end
-# Return collection of HardwareProfile objects
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [HardwareProfile]
-def hardware_profiles(opts={})
-end
-# Return StorageSnapshot object with given id
-
-#
-# Storage snapshots description here
-# @return [StorageSnapshot]
-def storage_snapshot
-end
-# Return collection of StorageSnapshot objects
-#
-# Storage snapshots description here
- # @param [string, id]
-# @return [Array] [StorageSnapshot]
-def storage_snapshots(opts={})
-end
-# Return Image object with given id
-
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
-# @return [Image]
-def image
-end
-# Return collection of Image objects
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
- # @param [string, architecture]
- # @param [string, owner_id]
- # @param [string, id]
-# @return [Array] [Image]
-def images(opts={})
-end
-# Return Realm object with given id
-
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
-# @return [Realm]
-def realm
-end
-# Return collection of Realm objects
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [Realm]
-def realms(opts={})
-end
- end
- class API::StorageVolume
- # Return URI to API for this object
-
- # @return [String] Value of uri
- def uri
- # This method was generated dynamically from API
- end
-
- # Get device attribute value from api::storagevolume
-
- # @return [String] Value of device
- def device
- # This method was generated dynamically from API
- end
-
- # Get id attribute value from api::storagevolume
-
- # @return [String] Value of id
- def id
- # This method was generated dynamically from API
- end
-
- # Return instance of API client
-
- # @return [String] Value of client
- def client
- # This method was generated dynamically from API
- end
-
- # Get capacity= attribute value from api::storagevolume
-
- # @return [String] Value of capacity=
- def capacity=
- # This method was generated dynamically from API
- end
-
- # Get device= attribute value from api::storagevolume
-
- # @return [String] Value of device=
- def device=
- # This method was generated dynamically from API
- end
-
- # Get instance attribute value from api::storagevolume
-
- # @return [String] Value of instance
- def instance
- # This method was generated dynamically from API
- end
-
- # Get created attribute value from api::storagevolume
-
- # @return [String] Value of created
- def created
- # This method was generated dynamically from API
- end
-
- # Get created= attribute value from api::storagevolume
-
- # @return [String] Value of created=
- def created=
- # This method was generated dynamically from API
- end
-
- # Get capacity attribute value from api::storagevolume
-
- # @return [String] Value of capacity
- def capacity
- # This method was generated dynamically from API
- end
-
- end
-end
-module DeltaCloud
- class API
-# Return InstanceState object with given id
-
-#
-# The possible states of an instance, and how to traverse between them
-# @return [InstanceState]
-def instance_state
-end
-# Return collection of InstanceState objects
-#
-# The possible states of an instance, and how to traverse between them
-# @return [Array] [InstanceState]
-def instance_states(opts={})
-end
-# Return StorageVolume object with given id
-
-#
-# Storage volumes description here
-# @return [StorageVolume]
-def storage_volume
-end
-# Return collection of StorageVolume objects
-#
-# Storage volumes description here
- # @param [string, id]
-# @return [Array] [StorageVolume]
-def storage_volumes(opts={})
-end
-# Return Instance object with given id
-
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
-# @return [Instance]
-def instance
-end
-# Return collection of Instance objects
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
- # @param [string, state]
- # @param [string, id]
-# @return [Array] [Instance]
-def instances(opts={})
-end
-# Return HardwareProfile object with given id
-
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
-# @return [HardwareProfile]
-def hardware_profile
-end
-# Return collection of HardwareProfile objects
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [HardwareProfile]
-def hardware_profiles(opts={})
-end
-# Return StorageSnapshot object with given id
-
-#
-# Storage snapshots description here
-# @return [StorageSnapshot]
-def storage_snapshot
-end
-# Return collection of StorageSnapshot objects
-#
-# Storage snapshots description here
- # @param [string, id]
-# @return [Array] [StorageSnapshot]
-def storage_snapshots(opts={})
-end
-# Return Image object with given id
-
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
-# @return [Image]
-def image
-end
-# Return collection of Image objects
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
- # @param [string, architecture]
- # @param [string, owner_id]
- # @param [string, id]
-# @return [Array] [Image]
-def images(opts={})
-end
-# Return Realm object with given id
-
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
-# @return [Realm]
-def realm
-end
-# Return collection of Realm objects
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [Realm]
-def realms(opts={})
-end
- end
- class API::Instance
- # Return URI to API for this object
-
- # @return [String] Value of uri
- def uri
- # This method was generated dynamically from API
- end
-
- # Get realm attribute value from api::instance
-
- # @return [String] Value of realm
- def realm
- # This method was generated dynamically from API
- end
-
- # Get reboot! attribute value from api::instance
-
- # @return [String] Value of reboot!
- def reboot!
- # This method was generated dynamically from API
- end
-
- # Get name= attribute value from api::instance
-
- # @return [String] Value of name=
- def name=
- # This method was generated dynamically from API
- end
-
- # Get private_addresses= attribute value from api::instance
-
- # @return [String] Value of private_addresses=
- def private_addresses=
- # This method was generated dynamically from API
- end
-
- # Get id attribute value from api::instance
-
- # @return [String] Value of id
- def id
- # This method was generated dynamically from API
- end
-
- # Return instance of API client
-
- # @return [String] Value of client
- def client
- # This method was generated dynamically from API
- end
-
- # Get owner_id attribute value from api::instance
-
- # @return [String] Value of owner_id
- def owner_id
- # This method was generated dynamically from API
- end
-
- # Get image attribute value from api::instance
-
- # @return [String] Value of image
- def image
- # This method was generated dynamically from API
- end
-
- # Get actions_urls attribute value from api::instance
-
- # @return [String] Value of actions_urls
- def actions_urls
- # This method was generated dynamically from API
- end
-
- # Get hardware_profile attribute value from api::instance
-
- # @return [String] Value of hardware_profile
- def hardware_profile
- # This method was generated dynamically from API
- end
-
- # Get owner_id= attribute value from api::instance
-
- # @return [String] Value of owner_id=
- def owner_id=
- # This method was generated dynamically from API
- end
-
- # Get destroy! attribute value from api::instance
-
- # @return [String] Value of destroy!
- def destroy!
- # This method was generated dynamically from API
- end
-
- # Get state attribute value from api::instance
-
- # @return [String] Value of state
- def state
- # This method was generated dynamically from API
- end
-
- # Read api::instance collection from Deltacloud API
- # @param [String, #id] Filter by ID
- # @return [String] Value of public_addresses
- def public_addresses
- # This method was generated dynamically from API
- end
-
- # Get stop! attribute value from api::instance
-
- # @return [String] Value of stop!
- def stop!
- # This method was generated dynamically from API
- end
-
- # Get actions attribute value from api::instance
-
- # @return [String] Value of actions
- def actions
- # This method was generated dynamically from API
- end
-
- # Get name attribute value from api::instance
-
- # @return [String] Value of name
- def name
- # This method was generated dynamically from API
- end
-
- # Read api::instance collection from Deltacloud API
- # @param [String, #id] Filter by ID
- # @return [String] Value of private_addresses
- def private_addresses
- # This method was generated dynamically from API
- end
-
- # Get start! attribute value from api::instance
-
- # @return [String] Value of start!
- def start!
- # This method was generated dynamically from API
- end
-
- # Get state= attribute value from api::instance
-
- # @return [String] Value of state=
- def state=
- # This method was generated dynamically from API
- end
-
- # Get public_addresses= attribute value from api::instance
-
- # @return [String] Value of public_addresses=
- def public_addresses=
- # This method was generated dynamically from API
- end
-
- end
-end
-module DeltaCloud
- class API
-# Return InstanceState object with given id
-
-#
-# The possible states of an instance, and how to traverse between them
-# @return [InstanceState]
-def instance_state
-end
-# Return collection of InstanceState objects
-#
-# The possible states of an instance, and how to traverse between them
-# @return [Array] [InstanceState]
-def instance_states(opts={})
-end
-# Return StorageVolume object with given id
-
-#
-# Storage volumes description here
-# @return [StorageVolume]
-def storage_volume
-end
-# Return collection of StorageVolume objects
-#
-# Storage volumes description here
- # @param [string, id]
-# @return [Array] [StorageVolume]
-def storage_volumes(opts={})
-end
-# Return Instance object with given id
-
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
-# @return [Instance]
-def instance
-end
-# Return collection of Instance objects
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
- # @param [string, state]
- # @param [string, id]
-# @return [Array] [Instance]
-def instances(opts={})
-end
-# Return HardwareProfile object with given id
-
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
-# @return [HardwareProfile]
-def hardware_profile
-end
-# Return collection of HardwareProfile objects
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [HardwareProfile]
-def hardware_profiles(opts={})
-end
-# Return StorageSnapshot object with given id
-
-#
-# Storage snapshots description here
-# @return [StorageSnapshot]
-def storage_snapshot
-end
-# Return collection of StorageSnapshot objects
-#
-# Storage snapshots description here
- # @param [string, id]
-# @return [Array] [StorageSnapshot]
-def storage_snapshots(opts={})
-end
-# Return Image object with given id
-
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
-# @return [Image]
-def image
-end
-# Return collection of Image objects
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
- # @param [string, architecture]
- # @param [string, owner_id]
- # @param [string, id]
-# @return [Array] [Image]
-def images(opts={})
-end
-# Return Realm object with given id
-
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
-# @return [Realm]
-def realm
-end
-# Return collection of Realm objects
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [Realm]
-def realms(opts={})
-end
- end
- class API::HardwareProfile
- # Return URI to API for this object
-
- # @return [String] Value of uri
- def uri
- # This method was generated dynamically from API
- end
-
- # Get cpu= attribute value from api::hardwareprofile
-
- # @return [String] Value of cpu=
- def cpu=
- # This method was generated dynamically from API
- end
-
- # Get name= attribute value from api::hardwareprofile
-
- # @return [String] Value of name=
- def name=
- # This method was generated dynamically from API
- end
-
- # Get storage attribute value from api::hardwareprofile
-
- # @return [String] Value of storage
- def storage
- # This method was generated dynamically from API
- end
-
- # Get id attribute value from api::hardwareprofile
-
- # @return [String] Value of id
- def id
- # This method was generated dynamically from API
- end
-
- # Return instance of API client
-
- # @return [String] Value of client
- def client
- # This method was generated dynamically from API
- end
-
- # Get architecture attribute value from api::hardwareprofile
-
- # @return [String] Value of architecture
- def architecture
- # This method was generated dynamically from API
- end
-
- # Get storage= attribute value from api::hardwareprofile
-
- # @return [String] Value of storage=
- def storage=
- # This method was generated dynamically from API
- end
-
- # Get architecture= attribute value from api::hardwareprofile
-
- # @return [String] Value of architecture=
- def architecture=
- # This method was generated dynamically from API
- end
-
- # Get memory attribute value from api::hardwareprofile
-
- # @return [String] Value of memory
- def memory
- # This method was generated dynamically from API
- end
-
- # Get cpu attribute value from api::hardwareprofile
-
- # @return [String] Value of cpu
- def cpu
- # This method was generated dynamically from API
- end
-
- # Get memory= attribute value from api::hardwareprofile
-
- # @return [String] Value of memory=
- def memory=
- # This method was generated dynamically from API
- end
-
- # Get name attribute value from api::hardwareprofile
-
- # @return [String] Value of name
- def name
- # This method was generated dynamically from API
- end
-
- end
-end
-module DeltaCloud
- class API
-# Return InstanceState object with given id
-
-#
-# The possible states of an instance, and how to traverse between them
-# @return [InstanceState]
-def instance_state
-end
-# Return collection of InstanceState objects
-#
-# The possible states of an instance, and how to traverse between them
-# @return [Array] [InstanceState]
-def instance_states(opts={})
-end
-# Return StorageVolume object with given id
-
-#
-# Storage volumes description here
-# @return [StorageVolume]
-def storage_volume
-end
-# Return collection of StorageVolume objects
-#
-# Storage volumes description here
- # @param [string, id]
-# @return [Array] [StorageVolume]
-def storage_volumes(opts={})
-end
-# Return Instance object with given id
-
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
-# @return [Instance]
-def instance
-end
-# Return collection of Instance objects
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
- # @param [string, state]
- # @param [string, id]
-# @return [Array] [Instance]
-def instances(opts={})
-end
-# Return HardwareProfile object with given id
-
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
-# @return [HardwareProfile]
-def hardware_profile
-end
-# Return collection of HardwareProfile objects
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [HardwareProfile]
-def hardware_profiles(opts={})
-end
-# Return StorageSnapshot object with given id
-
-#
-# Storage snapshots description here
-# @return [StorageSnapshot]
-def storage_snapshot
-end
-# Return collection of StorageSnapshot objects
-#
-# Storage snapshots description here
- # @param [string, id]
-# @return [Array] [StorageSnapshot]
-def storage_snapshots(opts={})
-end
-# Return Image object with given id
-
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
-# @return [Image]
-def image
-end
-# Return collection of Image objects
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
- # @param [string, architecture]
- # @param [string, owner_id]
- # @param [string, id]
-# @return [Array] [Image]
-def images(opts={})
-end
-# Return Realm object with given id
-
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
-# @return [Realm]
-def realm
-end
-# Return collection of Realm objects
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [Realm]
-def realms(opts={})
-end
- end
- class API::StorageSnapshot
- # Return URI to API for this object
-
- # @return [String] Value of uri
- def uri
- # This method was generated dynamically from API
- end
-
- # Get storage_volume attribute value from api::storagesnapshot
-
- # @return [String] Value of storage_volume
- def storage_volume
- # This method was generated dynamically from API
- end
-
- # Get id attribute value from api::storagesnapshot
-
- # @return [String] Value of id
- def id
- # This method was generated dynamically from API
- end
-
- # Return instance of API client
-
- # @return [String] Value of client
- def client
- # This method was generated dynamically from API
- end
-
- # Get created attribute value from api::storagesnapshot
-
- # @return [String] Value of created
- def created
- # This method was generated dynamically from API
- end
-
- # Get state attribute value from api::storagesnapshot
-
- # @return [String] Value of state
- def state
- # This method was generated dynamically from API
- end
-
- # Get created= attribute value from api::storagesnapshot
-
- # @return [String] Value of created=
- def created=
- # This method was generated dynamically from API
- end
-
- # Get state= attribute value from api::storagesnapshot
-
- # @return [String] Value of state=
- def state=
- # This method was generated dynamically from API
- end
-
- end
-end
-module DeltaCloud
- class API
-# Return InstanceState object with given id
-
-#
-# The possible states of an instance, and how to traverse between them
-# @return [InstanceState]
-def instance_state
-end
-# Return collection of InstanceState objects
-#
-# The possible states of an instance, and how to traverse between them
-# @return [Array] [InstanceState]
-def instance_states(opts={})
-end
-# Return StorageVolume object with given id
-
-#
-# Storage volumes description here
-# @return [StorageVolume]
-def storage_volume
-end
-# Return collection of StorageVolume objects
-#
-# Storage volumes description here
- # @param [string, id]
-# @return [Array] [StorageVolume]
-def storage_volumes(opts={})
-end
-# Return Instance object with given id
-
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
-# @return [Instance]
-def instance
-end
-# Return collection of Instance objects
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
- # @param [string, state]
- # @param [string, id]
-# @return [Array] [Instance]
-def instances(opts={})
-end
-# Return HardwareProfile object with given id
-
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
-# @return [HardwareProfile]
-def hardware_profile
-end
-# Return collection of HardwareProfile objects
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [HardwareProfile]
-def hardware_profiles(opts={})
-end
-# Return StorageSnapshot object with given id
-
-#
-# Storage snapshots description here
-# @return [StorageSnapshot]
-def storage_snapshot
-end
-# Return collection of StorageSnapshot objects
-#
-# Storage snapshots description here
- # @param [string, id]
-# @return [Array] [StorageSnapshot]
-def storage_snapshots(opts={})
-end
-# Return Image object with given id
-
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
-# @return [Image]
-def image
-end
-# Return collection of Image objects
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
- # @param [string, architecture]
- # @param [string, owner_id]
- # @param [string, id]
-# @return [Array] [Image]
-def images(opts={})
-end
-# Return Realm object with given id
-
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
-# @return [Realm]
-def realm
-end
-# Return collection of Realm objects
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [Realm]
-def realms(opts={})
-end
- end
- class API::Image
- # Return URI to API for this object
-
- # @return [String] Value of uri
- def uri
- # This method was generated dynamically from API
- end
-
- # Get name= attribute value from api::image
-
- # @return [String] Value of name=
- def name=
- # This method was generated dynamically from API
- end
-
- # Get id attribute value from api::image
-
- # @return [String] Value of id
- def id
- # This method was generated dynamically from API
- end
-
- # Return instance of API client
-
- # @return [String] Value of client
- def client
- # This method was generated dynamically from API
- end
-
- # Get architecture attribute value from api::image
-
- # @return [String] Value of architecture
- def architecture
- # This method was generated dynamically from API
- end
-
- # Get owner_id attribute value from api::image
-
- # @return [String] Value of owner_id
- def owner_id
- # This method was generated dynamically from API
- end
-
- # Get description attribute value from api::image
-
- # @return [String] Value of description
- def description
- # This method was generated dynamically from API
- end
-
- # Get architecture= attribute value from api::image
-
- # @return [String] Value of architecture=
- def architecture=
- # This method was generated dynamically from API
- end
-
- # Get owner_id= attribute value from api::image
-
- # @return [String] Value of owner_id=
- def owner_id=
- # This method was generated dynamically from API
- end
-
- # Get description= attribute value from api::image
-
- # @return [String] Value of description=
- def description=
- # This method was generated dynamically from API
- end
-
- # Get name attribute value from api::image
-
- # @return [String] Value of name
- def name
- # This method was generated dynamically from API
- end
-
- end
-end
-module DeltaCloud
- class API
-# Return InstanceState object with given id
-
-#
-# The possible states of an instance, and how to traverse between them
-# @return [InstanceState]
-def instance_state
-end
-# Return collection of InstanceState objects
-#
-# The possible states of an instance, and how to traverse between them
-# @return [Array] [InstanceState]
-def instance_states(opts={})
-end
-# Return StorageVolume object with given id
-
-#
-# Storage volumes description here
-# @return [StorageVolume]
-def storage_volume
-end
-# Return collection of StorageVolume objects
-#
-# Storage volumes description here
- # @param [string, id]
-# @return [Array] [StorageVolume]
-def storage_volumes(opts={})
-end
-# Return Instance object with given id
-
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
-# @return [Instance]
-def instance
-end
-# Return collection of Instance objects
-#
-#
-# An instance is a concrete machine realized from an image.
-# The images collection may be obtained by following the link from the primary entry-point."
-#
- # @param [string, state]
- # @param [string, id]
-# @return [Array] [Instance]
-def instances(opts={})
-end
-# Return HardwareProfile object with given id
-
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
-# @return [HardwareProfile]
-def hardware_profile
-end
-# Return collection of HardwareProfile objects
-#
-#
-# A hardware profile represents a configuration of resources upon which a
-# machine may be deployed. It defines aspects such as local disk storage,
-# available RAM, and architecture. Each provider is free to define as many
-# (or as few) hardware profiles as desired.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [HardwareProfile]
-def hardware_profiles(opts={})
-end
-# Return StorageSnapshot object with given id
-
-#
-# Storage snapshots description here
-# @return [StorageSnapshot]
-def storage_snapshot
-end
-# Return collection of StorageSnapshot objects
-#
-# Storage snapshots description here
- # @param [string, id]
-# @return [Array] [StorageSnapshot]
-def storage_snapshots(opts={})
-end
-# Return Image object with given id
-
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
-# @return [Image]
-def image
-end
-# Return collection of Image objects
-#
-#
-# An image is a platonic form of a machine. Images are not directly executable,
-# but are a template for creating actual instances of machines."
-#
- # @param [string, architecture]
- # @param [string, owner_id]
- # @param [string, id]
-# @return [Array] [Image]
-def images(opts={})
-end
-# Return Realm object with given id
-
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
-# @return [Realm]
-def realm
-end
-# Return collection of Realm objects
-#
-#
-# Within a cloud provider a realm represents a boundary containing resources.
-# The exact definition of a realm is left to the cloud provider.
-# In some cases, a realm may represent different datacenters, different continents,
-# or different pools of resources within a single datacenter.
-# A cloud provider may insist that resources must all exist within a single realm in
-# order to cooperate. For instance, storage volumes may only be allowed to be mounted to
-# instances within the same realm.
-#
- # @param [string, architecture]
- # @param [string, id]
-# @return [Array] [Realm]
-def realms(opts={})
-end
- end
- class API::Realm
- # Return URI to API for this object
-
- # @return [String] Value of uri
- def uri
- # This method was generated dynamically from API
- end
-
- # Get name= attribute value from api::realm
-
- # @return [String] Value of name=
- def name=
- # This method was generated dynamically from API
- end
-
- # Get limit attribute value from api::realm
-
- # @return [String] Value of limit
- def limit
- # This method was generated dynamically from API
- end
-
- # Get id attribute value from api::realm
-
- # @return [String] Value of id
- def id
- # This method was generated dynamically from API
- end
-
- # Return instance of API client
-
- # @return [String] Value of client
- def client
- # This method was generated dynamically from API
- end
-
- # Get limit= attribute value from api::realm
-
- # @return [String] Value of limit=
- def limit=
- # This method was generated dynamically from API
- end
-
- # Get state attribute value from api::realm
-
- # @return [String] Value of state
- def state
- # This method was generated dynamically from API
- end
-
- # Get name attribute value from api::realm
-
- # @return [String] Value of name
- def name
- # This method was generated dynamically from API
- end
-
- # Get state= attribute value from api::realm
-
- # @return [String] Value of state=
- def state=
- # This method was generated dynamically from API
- end
-
- end
-end
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/71afec55/client/doc/file.README.html
----------------------------------------------------------------------
diff --git a/client/doc/file.README.html b/client/doc/file.README.html
deleted file mode 100644
index 1e9aacb..0000000
--- a/client/doc/file.README.html
+++ /dev/null
@@ -1,184 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta name="Content-Type" content="text/html; charset=utf-8" />
-<title>Deltacloud Client Library</title>
-<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
-<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
-
-<script type="text/javascript" charset="utf-8">
- relpath = '';
- if (relpath != '') relpath += '/';
-</script>
-<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-
- </head>
- <body>
- <script type="text/javascript" charset="utf-8">
- if (window.top.frames.main) document.body.className = 'frames';
- </script>
-
- <div id="header">
- <div id="menu">
-
- <a href="_index.html" title="Index">Index</a> »
- <span class="title">File: README</span>
-
-
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-
- <div id="search">
- <a id="class_list_link" href="#">Class List</a>
- <a id="method_list_link" href="#">Method List</a>
- <a id ="file_list_link" href="#">File List</a>
-</div>
-
- <div class="clear"></div>
- </div>
-
- <iframe id="search_frame"></iframe>
-
- <div id="content"><div id='filecontents'><h1 id='deltacloud_client_ruby'>Deltacloud Client (Ruby)</h1>
-
-<p>The Deltacloud project includes a Ruby client. Other language-bindings are possible and will be supported soon. The client aims to insulate users from having to deal with HTTP and REST directly.</p>
-
-<p>Each resource type has an associated model to ease usage. Where resource reference other resources, natural navigation across the object model is possible.</p>
-
-<p>For example</p>
-
-<pre class="code"><span class='puts identifier id'>puts</span> <span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='dot token'>.</span><span class='name identifier id'>name</span>
-<span class='puts identifier id'>puts</span> <span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='hardware_profile identifier id'>hardware_profile</span><span class='dot token'>.</span><span class='architecture identifier id'>architecture</span>
-</pre>
-
-<h2 id='basics'>Basics</h2>
-
-<p>To use the client, you must require <code>deltacloud</code>.</p>
-
-<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'deltacloud'</span>
-</pre>
-
-<h2 id='connecting_to_a_deltacloud_provider'>Connecting to a Deltacloud provider</h2>
-
-<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'deltacloud'</span>
-
-<span class='api_url identifier id'>api_url</span> <span class='assign token'>=</span> <span class='string val'>'http://localhost:3001/api'</span>
-<span class='api_name identifier id'>api_name</span> <span class='assign token'>=</span> <span class='string val'>'mockuser'</span>
-<span class='api_password identifier id'>api_password</span> <span class='assign token'>=</span> <span class='string val'>'mockpassword'</span>
-
-<span class='client identifier id'>client</span> <span class='assign token'>=</span> <span class='DeltaCloud constant id'>DeltaCloud</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span> <span class='api_name identifier id'>api_name</span><span class='comma token'>,</span> <span class='api_password identifier id'>api_password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span> <span class='rparen token'>)</span>
-
-<span class='comment val'># work with client here</span>
-</pre>
-
-<p>In addition to creating a client, operations may occur within a block included on the initialization</p>
-
-<pre class="code"><span class='DeltaCloud constant id'>DeltaCloud</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span> <span class='api_name identifier id'>api_name</span><span class='comma token'>,</span> <span class='api_password identifier id'>api_password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span> <span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='client identifier id'>client</span><span class='bitor op'>|</span>
- <span class='comment val'># work with client here</span>
-<span class='end end kw'>end</span>
-</pre>
-
-<p>In the event of a failure, any underlying HTTP transport exceptions will be thrown all the way out to the caller.</p>
-
-<h2 id='listing_realms'>Listing realms</h2>
-
-<p>You may retrieve a complete list of realms available to you</p>
-
-<pre class="code"><span class='realms identifier id'>realms</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='realms identifier id'>realms</span>
-</pre>
-
-<p>You may retrieve a specific realm by its identifier</p>
-
-<pre class="code"><span class='realm identifier id'>realm</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='realm identifier id'>realm</span><span class='lparen token'>(</span> <span class='string val'>'us'</span> <span class='rparen token'>)</span>
-</pre>
-
-<h2 id='listing_hardware_profiles'>Listing hardware profiles</h2>
-
-<p>You may retrieve a complete list of hardware profiles available for launching machines</p>
-
-<pre class="code"><span class='hwp identifier id'>hwp</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profiles identifier id'>hardware_profiles</span>
-</pre>
-
-<p>You may filter hardware profiles by architecture</p>
-
-<pre class="code"><span class='flavors identifier id'>flavors</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profiles identifier id'>hardware_profiles</span><span class='lparen token'>(</span> <span class='symbol val'>:architecture=</span><span class='gt op'>></span><span class='string val'>'x86_64'</span> <span class='rparen token'>)</span>
-</pre>
-
-<p>You may retrieve a specific hardware profile by its identifier</p>
-
-<pre class="code"><span class='flavor identifier id'>flavor</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profile identifier id'>hardware_profile</span><span class='lparen token'>(</span> <span class='string val'>'m1-small'</span> <span class='rparen token'>)</span>
-</pre>
-
-<h2 id='listing_images'>Listing images</h2>
-
-<p>You may retrieve a complete list of images</p>
-
-<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span>
-</pre>
-
-<p>You may retrieve a list of images owned by the currently authenticated user</p>
-
-<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='lparen token'>(</span> <span class='symbol val'>:owner_id=</span><span class='gt op'>></span><span class='symbol val'>:self</span> <span class='rparen token'>)</span>
-</pre>
-
-<p>You may retrieve a list of images visible to you but owned by a specific user</p>
-
-<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='lparen token'>(</span> <span class='symbol val'>:owner_id=</span><span class='gt op'>></span><span class='string val'>'daryll'</span> <span class='rparen token'>)</span>
-</pre>
-
-<p>You may retrieve a specific image by its identifier</p>
-
-<pre class="code"><span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='lparen token'>(</span> <span class='string val'>'ami-8675309'</span> <span class='rparen token'>)</span>
-</pre>
-
-<h2 id='listing_instances'>Listing instances</h2>
-
-<p>You may retrieve a list of all instances visible to you</p>
-
-<pre class="code"><span class='instances identifier id'>instances</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='instances identifier id'>instances</span>
-</pre>
-
-<p>You may retrieve a specific instance by its identifier</p>
-
-<pre class="code"><span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='instance identifier id'>instance</span><span class='lparen token'>(</span> <span class='string val'>'i-90125'</span> <span class='rparen token'>)</span>
-</pre>
-
-<h2 id='launching_instances'>Launching instances</h2>
-
-<p>An instance may be launched using just an image identifier</p>
-
-<pre class="code"><span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='lparen token'>(</span> <span class='string val'>'ami-8675309'</span> <span class='rparen token'>)</span>
-<span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='create_instance identifier id'>create_instance</span><span class='lparen token'>(</span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='id identifier id'>id</span> <span class='rparen token'>)</span>
-</pre>
-
-<p>Optionally, a flavor or realm may be specified</p>
-
-<pre class="code"><span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='create_instance identifier id'>create_instance</span><span class='lparen token'>(</span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='id identifier id'>id</span><span class='comma token'>,</span> <span class='symbol val'>:flavor=</span><span class='gt op'>></span><span class='string val'>'m1-small'</span><span class='comma token'>,</span> <span class='symbol val'>:realm=</span><span class='gt op'>></span><span class='string val'>'us'</span> <span class='rparen token'>)</span>
-</pre>
-
-<h2 id='manipulating_instances'>Manipulating instances</h2>
-
-<p>Given an instance, depending on its state, various actions <em>may</em> be available.</p>
-
-<p>To determine what’s available, the <code>instance#actions</code> method may be used.</p>
-
-<pre class="code"><span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='actions identifier id'>actions</span> <span class='comment val'># [ 'reboot', 'stop' ]</span>
-</pre>
-
-<p>For a valid action, the method matching the action with an exclamation point may be called.</p>
-
-<pre class="code"><span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='reboot! fid id'>reboot!</span>
-</pre>
-
-<p>Upon invoking an action, the instance will refresh its contents, in case the state has changed. To determine later if the state has changed again, the instance must be refetched using the <code>client.instance(...)</code> method.</p></div></div>
-
- <div id="footer">
- Generated on Fri Jul 30 12:16:23 2010 by
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
- 0.5.6 (ruby-1.8.7).
-</div>
-
- </body>
-</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/71afec55/client/doc/file_list.html
----------------------------------------------------------------------
diff --git a/client/doc/file_list.html b/client/doc/file_list.html
deleted file mode 100644
index 7115ba1..0000000
--- a/client/doc/file_list.html
+++ /dev/null
@@ -1,38 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html>
- <head>
- <meta name="Content-Type" content="text/html; charset=utf-8" />
- <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
- <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
- <base id="base_target" target="_parent" />
- </head>
- <body>
- <script type="text/javascript" charset="utf-8">
- if (window.top.frames.main) {
- document.getElementById('base_target').target = 'main';
- document.body.className = 'frames';
- }
- </script>
- <div id="content">
- <h1 id="full_list_header">File List</h1>
- <div id="nav">
- <a target="_self" href="class_list.html">Classes</a> |
- <a target="_self" href="method_list.html">Methods</a> |
- <a target="_self" href="file_list.html">Files</a>
- </div>
- <div id="search">Search: <input type="text" /></div>
-
- <ul id="full_list" class="files">
-
-
- <li class="r1"><a href="index.html" title="README">README</a></li>
-
-
- </ul>
- </div>
- </body>
-</html>
-
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/71afec55/client/doc/frames.html
----------------------------------------------------------------------
diff --git a/client/doc/frames.html b/client/doc/frames.html
deleted file mode 100644
index 6083d03..0000000
--- a/client/doc/frames.html
+++ /dev/null
@@ -1,13 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
- <title>Deltacloud Client Library</title>
-</head>
-<frameset cols="20%,*">
- <frame name="list" src="class_list.html" />
- <frame name="main" src="index.html" />
-</frameset>
-</html>
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/71afec55/client/doc/index.html
----------------------------------------------------------------------
diff --git a/client/doc/index.html b/client/doc/index.html
deleted file mode 100644
index 1e9aacb..0000000
--- a/client/doc/index.html
+++ /dev/null
@@ -1,184 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta name="Content-Type" content="text/html; charset=utf-8" />
-<title>Deltacloud Client Library</title>
-<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
-<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
-
-<script type="text/javascript" charset="utf-8">
- relpath = '';
- if (relpath != '') relpath += '/';
-</script>
-<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-
- </head>
- <body>
- <script type="text/javascript" charset="utf-8">
- if (window.top.frames.main) document.body.className = 'frames';
- </script>
-
- <div id="header">
- <div id="menu">
-
- <a href="_index.html" title="Index">Index</a> »
- <span class="title">File: README</span>
-
-
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-
- <div id="search">
- <a id="class_list_link" href="#">Class List</a>
- <a id="method_list_link" href="#">Method List</a>
- <a id ="file_list_link" href="#">File List</a>
-</div>
-
- <div class="clear"></div>
- </div>
-
- <iframe id="search_frame"></iframe>
-
- <div id="content"><div id='filecontents'><h1 id='deltacloud_client_ruby'>Deltacloud Client (Ruby)</h1>
-
-<p>The Deltacloud project includes a Ruby client. Other language-bindings are possible and will be supported soon. The client aims to insulate users from having to deal with HTTP and REST directly.</p>
-
-<p>Each resource type has an associated model to ease usage. Where resource reference other resources, natural navigation across the object model is possible.</p>
-
-<p>For example</p>
-
-<pre class="code"><span class='puts identifier id'>puts</span> <span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='dot token'>.</span><span class='name identifier id'>name</span>
-<span class='puts identifier id'>puts</span> <span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='hardware_profile identifier id'>hardware_profile</span><span class='dot token'>.</span><span class='architecture identifier id'>architecture</span>
-</pre>
-
-<h2 id='basics'>Basics</h2>
-
-<p>To use the client, you must require <code>deltacloud</code>.</p>
-
-<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'deltacloud'</span>
-</pre>
-
-<h2 id='connecting_to_a_deltacloud_provider'>Connecting to a Deltacloud provider</h2>
-
-<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'deltacloud'</span>
-
-<span class='api_url identifier id'>api_url</span> <span class='assign token'>=</span> <span class='string val'>'http://localhost:3001/api'</span>
-<span class='api_name identifier id'>api_name</span> <span class='assign token'>=</span> <span class='string val'>'mockuser'</span>
-<span class='api_password identifier id'>api_password</span> <span class='assign token'>=</span> <span class='string val'>'mockpassword'</span>
-
-<span class='client identifier id'>client</span> <span class='assign token'>=</span> <span class='DeltaCloud constant id'>DeltaCloud</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span> <span class='api_name identifier id'>api_name</span><span class='comma token'>,</span> <span class='api_password identifier id'>api_password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span> <span class='rparen token'>)</span>
-
-<span class='comment val'># work with client here</span>
-</pre>
-
-<p>In addition to creating a client, operations may occur within a block included on the initialization</p>
-
-<pre class="code"><span class='DeltaCloud constant id'>DeltaCloud</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span> <span class='api_name identifier id'>api_name</span><span class='comma token'>,</span> <span class='api_password identifier id'>api_password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span> <span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='client identifier id'>client</span><span class='bitor op'>|</span>
- <span class='comment val'># work with client here</span>
-<span class='end end kw'>end</span>
-</pre>
-
-<p>In the event of a failure, any underlying HTTP transport exceptions will be thrown all the way out to the caller.</p>
-
-<h2 id='listing_realms'>Listing realms</h2>
-
-<p>You may retrieve a complete list of realms available to you</p>
-
-<pre class="code"><span class='realms identifier id'>realms</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='realms identifier id'>realms</span>
-</pre>
-
-<p>You may retrieve a specific realm by its identifier</p>
-
-<pre class="code"><span class='realm identifier id'>realm</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='realm identifier id'>realm</span><span class='lparen token'>(</span> <span class='string val'>'us'</span> <span class='rparen token'>)</span>
-</pre>
-
-<h2 id='listing_hardware_profiles'>Listing hardware profiles</h2>
-
-<p>You may retrieve a complete list of hardware profiles available for launching machines</p>
-
-<pre class="code"><span class='hwp identifier id'>hwp</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profiles identifier id'>hardware_profiles</span>
-</pre>
-
-<p>You may filter hardware profiles by architecture</p>
-
-<pre class="code"><span class='flavors identifier id'>flavors</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profiles identifier id'>hardware_profiles</span><span class='lparen token'>(</span> <span class='symbol val'>:architecture=</span><span class='gt op'>></span><span class='string val'>'x86_64'</span> <span class='rparen token'>)</span>
-</pre>
-
-<p>You may retrieve a specific hardware profile by its identifier</p>
-
-<pre class="code"><span class='flavor identifier id'>flavor</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profile identifier id'>hardware_profile</span><span class='lparen token'>(</span> <span class='string val'>'m1-small'</span> <span class='rparen token'>)</span>
-</pre>
-
-<h2 id='listing_images'>Listing images</h2>
-
-<p>You may retrieve a complete list of images</p>
-
-<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span>
-</pre>
-
-<p>You may retrieve a list of images owned by the currently authenticated user</p>
-
-<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='lparen token'>(</span> <span class='symbol val'>:owner_id=</span><span class='gt op'>></span><span class='symbol val'>:self</span> <span class='rparen token'>)</span>
-</pre>
-
-<p>You may retrieve a list of images visible to you but owned by a specific user</p>
-
-<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='lparen token'>(</span> <span class='symbol val'>:owner_id=</span><span class='gt op'>></span><span class='string val'>'daryll'</span> <span class='rparen token'>)</span>
-</pre>
-
-<p>You may retrieve a specific image by its identifier</p>
-
-<pre class="code"><span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='lparen token'>(</span> <span class='string val'>'ami-8675309'</span> <span class='rparen token'>)</span>
-</pre>
-
-<h2 id='listing_instances'>Listing instances</h2>
-
-<p>You may retrieve a list of all instances visible to you</p>
-
-<pre class="code"><span class='instances identifier id'>instances</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='instances identifier id'>instances</span>
-</pre>
-
-<p>You may retrieve a specific instance by its identifier</p>
-
-<pre class="code"><span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='instance identifier id'>instance</span><span class='lparen token'>(</span> <span class='string val'>'i-90125'</span> <span class='rparen token'>)</span>
-</pre>
-
-<h2 id='launching_instances'>Launching instances</h2>
-
-<p>An instance may be launched using just an image identifier</p>
-
-<pre class="code"><span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='lparen token'>(</span> <span class='string val'>'ami-8675309'</span> <span class='rparen token'>)</span>
-<span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='create_instance identifier id'>create_instance</span><span class='lparen token'>(</span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='id identifier id'>id</span> <span class='rparen token'>)</span>
-</pre>
-
-<p>Optionally, a flavor or realm may be specified</p>
-
-<pre class="code"><span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='create_instance identifier id'>create_instance</span><span class='lparen token'>(</span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='id identifier id'>id</span><span class='comma token'>,</span> <span class='symbol val'>:flavor=</span><span class='gt op'>></span><span class='string val'>'m1-small'</span><span class='comma token'>,</span> <span class='symbol val'>:realm=</span><span class='gt op'>></span><span class='string val'>'us'</span> <span class='rparen token'>)</span>
-</pre>
-
-<h2 id='manipulating_instances'>Manipulating instances</h2>
-
-<p>Given an instance, depending on its state, various actions <em>may</em> be available.</p>
-
-<p>To determine what’s available, the <code>instance#actions</code> method may be used.</p>
-
-<pre class="code"><span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='actions identifier id'>actions</span> <span class='comment val'># [ 'reboot', 'stop' ]</span>
-</pre>
-
-<p>For a valid action, the method matching the action with an exclamation point may be called.</p>
-
-<pre class="code"><span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='reboot! fid id'>reboot!</span>
-</pre>
-
-<p>Upon invoking an action, the instance will refresh its contents, in case the state has changed. To determine later if the state has changed again, the instance must be refetched using the <code>client.instance(...)</code> method.</p></div></div>
-
- <div id="footer">
- Generated on Fri Jul 30 12:16:23 2010 by
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
- 0.5.6 (ruby-1.8.7).
-</div>
-
- </body>
-</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/71afec55/client/doc/js/app.js
----------------------------------------------------------------------
diff --git a/client/doc/js/app.js b/client/doc/js/app.js
deleted file mode 100644
index ca73848..0000000
--- a/client/doc/js/app.js
+++ /dev/null
@@ -1,138 +0,0 @@
-function createSourceLinks() {
- $('.method_details_list .source_code').
- before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
- $('.toggleSource').toggle(function() {
- $(this).parent().next().slideDown(100);
- $(this).text("Hide source");
- },
- function() {
- $(this).parent().next().slideUp(100);
- $(this).text("View source");
- });
-}
-
-function createDefineLinks() {
- var tHeight = 0;
- $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
- $('.toggleDefines').toggle(function() {
- tHeight = $(this).parent().prev().height();
- $(this).prev().show();
- $(this).parent().prev().height($(this).parent().height());
- $(this).text("(less)");
- },
- function() {
- $(this).prev().hide();
- $(this).parent().prev().height(tHeight);
- $(this).text("more...")
- });
-}
-
-function createFullTreeLinks() {
- var tHeight = 0;
- $('.inheritanceTree').toggle(function() {
- tHeight = $(this).parent().prev().height();
- $(this).prev().prev().hide();
- $(this).prev().show();
- $(this).text("(hide)");
- $(this).parent().prev().height($(this).parent().height());
- },
- function() {
- $(this).prev().prev().show();
- $(this).prev().hide();
- $(this).parent().prev().height(tHeight);
- $(this).text("show all")
- });
-}
-
-function fixBoxInfoHeights() {
- $('dl.box dd.r1, dl.box dd.r2').each(function() {
- $(this).prev().height($(this).height());
- });
-}
-
-function searchFrameLinks() {
- $('#method_list_link').click(function() {
- toggleSearchFrame(this, relpath + 'method_list.html');
- });
-
- $('#class_list_link').click(function() {
- toggleSearchFrame(this, relpath + 'class_list.html');
- });
-
- $('#file_list_link').click(function() {
- toggleSearchFrame(this, relpath + 'file_list.html');
- });
-}
-
-function toggleSearchFrame(id, link) {
- var frame = $('#search_frame');
- $('#search a').removeClass('active').addClass('inactive');
- if (frame.attr('src') == link && frame.css('display') != "none") {
- frame.slideUp(100);
- $('#search a').removeClass('active inactive');
- }
- else {
- $(id).addClass('active').removeClass('inactive');
- frame.attr('src', link).slideDown(100);
- }
-}
-
-function linkSummaries() {
- $('.summary_signature').click(function() {
- document.location = $(this).find('a').attr('href');
- });
-}
-
-function framesInit() {
- if (window.top.frames.main) {
- document.body.className = 'frames';
- $('#menu .noframes a').attr('href', document.location);
- }
-}
-
-function keyboardShortcuts() {
- if (window.top.frames.main) return;
- $(document).keypress(function(evt) {
- if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
- if (evt.originalTarget.nodeName == "INPUT" ||
- evt.originalTarget.nodeName == "TEXTAREA") return;
- switch (evt.charCode) {
- case 67: case 99: $('#class_list_link').click(); break; // 'c'
- case 77: case 109: $('#method_list_link').click(); break; // 'm'
- case 70: case 102: $('#file_list_link').click(); break; // 'f'
- }
- });
-}
-
-function summaryToggle() {
- $('.summary_toggle').click(function() {
- $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
- var next = $(this).parent().parent().next();
- if (next.hasClass('compact')) {
- next.toggle();
- next.next().toggle();
- }
- else if (next.hasClass('summary')) {
- var list = $('<ul class="summary compact" />');
- list.html(next.html());
- list.find('.summary_desc, .note').remove();
- list.find('a').each(function() {
- $(this).html($(this).find('strong').html());
- $(this).parent().html($(this)[0].outerHTML);
- });
- next.before(list);
- next.toggle();
- }
- return false;
- })
-}
-
-$(framesInit);
-$(createSourceLinks);
-$(createDefineLinks);
-$(createFullTreeLinks);
-$(fixBoxInfoHeights);
-$(searchFrameLinks);
-$(linkSummaries);
-$(keyboardShortcuts);
-$(summaryToggle);
http://git-wip-us.apache.org/repos/asf/deltacloud/blob/71afec55/client/doc/js/full_list.js
----------------------------------------------------------------------
diff --git a/client/doc/js/full_list.js b/client/doc/js/full_list.js
deleted file mode 100644
index 280cee0..0000000
--- a/client/doc/js/full_list.js
+++ /dev/null
@@ -1,117 +0,0 @@
-function fullListSearch() {
- $('#search input').keyup(function() {
- var value = this.value.toLowerCase();
- if (value == "") {
- $('#full_list').removeClass('insearch');
- $('#full_list li').each(function() {
- var link = $(this).children('a:last');
- link.text(link.text());
- });
- if (clicked) {
- clicked.parents('ul').each(function() {
- $(this).removeClass('collapsed').prev().removeClass('collapsed');
- });
- }
- highlight();
- }
- else {
- $('#full_list').addClass('insearch');
- $('#full_list li').each(function() {
- var link = $(this).children('a:last');
- var text = link.text();
- if (text.toLowerCase().indexOf(value) == -1) {
- $(this).removeClass('found');
- link.text(link.text());
- }
- else {
- $(this).css('padding-left', '10px').addClass('found');
- link.html(link.text().replace(new RegExp("(" +
- value.replace(/([\/.*+?|()\[\]{}\\])/g, "\\$1") + ")", "ig"),
- '<strong>$1</strong>'));
- }
- });
- highlight(true);
- }
-
- if ($('#full_list li:visible').size() == 0) {
- $('#noresults').fadeIn();
- }
- else {
- $('#noresults').hide();
- }
- });
-
- $('#search input').focus();
- $('#full_list').after("<div id='noresults'>No results were found.</div>")
-}
-
-clicked = null;
-function linkList() {
- $('#full_list li, #full_list li a:last').click(function(evt) {
- if ($(this).hasClass('toggle')) return true;
- if (this.tagName.toLowerCase() == "li") {
- var toggle = $(this).children('a.toggle');
- if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
- toggle.click();
- return false;
- }
- }
- if (clicked) clicked.removeClass('clicked');
- var win = window.parent;
- if (window.top.frames.main) {
- win = window.top.frames.main;
- var title = $('html head title', win.document).text();
- $('html head title', window.parent.document).text(title);
- }
- if (this.tagName.toLowerCase() == "a") {
- clicked = $(this).parent('li').addClass('clicked');
- win.location = this.href;
- }
- else {
- clicked = $(this).addClass('clicked');
- win.location = $(this).find('a:last').attr('href');
- }
- return false;
- });
-}
-
-function collapse() {
- if (!$('#full_list').hasClass('class')) return;
- $('#full_list.class a.toggle').click(function() {
- $(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
- highlight();
- return false;
- });
- $('#full_list.class ul').each(function() {
- $(this).addClass('collapsed').prev().addClass('collapsed');
- });
- $('#full_list.class').children().removeClass('collapsed');
- highlight();
-}
-
-function highlight(no_padding) {
- var n = 1;
- $('#full_list li:visible').each(function() {
- var next = n == 1 ? 2 : 1;
- $(this).removeClass("r" + next).addClass("r" + n);
- if (!no_padding && $('#full_list').hasClass('class')) {
- $(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
- }
- n = next;
- });
-}
-
-function escapeShortcut() {
- $(document).keydown(function(evt) {
- if (evt.which == 27) {
- $('#search_frame', window.top.document).slideUp(100);
- $('#search a', window.top.document).removeClass('active inactive')
- $(window.top).focus();
- }
- });
-}
-
-$(escapeShortcut);
-$(fullListSearch);
-$(linkList);
-$(collapse);