l.s.d.a.AtmosDriver(StorageDriver) : class documentation

Part of libcloud.storage.drivers.atmos View Source View In Hierarchy

Known subclasses: libcloud.storage.drivers.ninefold.NinefoldStorageDriver

Undocumented
Method __init__
Method list_containers Undocumented
Method get_container Return a container instance.
Method create_container Create a new container.
Method delete_container Delete a container.
Method get_object Return an object instance.
Method upload_object Upload an object.
Method upload_object_via_stream
Method download_object Download an object to the specified destination path.
Method download_object_as_stream Return a generator which yields object data.
Method delete_object Delete an object.
Method list_container_objects Return a list of objects for the given container.
Method enable_object_cdn Undocumented
Method get_object_cdn_url Return a container CDN URL.
Method _cdn_signature Undocumented
Method _list_objects Undocumented
Method _namespace_path Undocumented
Method _object_path Undocumented
Static Method _emc_tag Undocumented
Method _emc_meta Undocumented
Method _get_more Undocumented

Inherited from StorageDriver:

Method list_containters Return a list of containers.
Method get_container_cdn_url Return a container CDN URL.
Method enable_container_cdn Undocumented
Method _get_object Call passed callback and start transfer of the object'
Method _save_object Save object to the provided path.
Method _upload_object Helper function for setting common request headers and calling the passed in callback which uploads an object.
Method _stream_data Stream a data over an http connection.
Method _upload_file Upload a file to the server.

Inherited from BaseDriver (via StorageDriver):

Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.
def __init__(self, key, secret=None, secure=True, host=None, port=None): (source)
ParameterskeyAPI key or username to used (type: str)
secretSecret password to be used (type: str)
secureWeither to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default. (type: bool)
hostOverride hostname used for connections. (type: str)
portOverride port used for connections. (type: int)
api_versionOptional API version. Only used by drivers which support multiple API versions. (type: str)
def list_containers(self): (source)
Undocumented
def get_container(self, container_name): (source)
Return a container instance.
Parameterscontainer_nameContainer name. (type: str)
ReturnsContainer instance.
def create_container(self, container_name): (source)
Create a new container.
Parameterscontainer_nameContainer name. (type: str)
ReturnsContainer instance on success.
def delete_container(self, container): (source)
Delete a container.
ParameterscontainerContainer instance (type: Container)
ReturnsTrue on success, False otherwise. (type: bool)
def get_object(self, container_name, object_name): (source)
Return an object instance.
Parameterscontainer_nameContainer name. (type: str)
object_nameObject name. (type: str)
ReturnsObject instance.
def upload_object(self, file_path, container, object_name, extra=None, verify_hash=True): (source)
Upload an object.
Parametersfile_pathPath to the object on disk. (type: str)
containerDestination container. (type: Container)
object_nameObject name. (type: str)
extra(optional) Extra attributes (driver specific). (type: dict)
def upload_object_via_stream(self, iterator, container, object_name, extra=None): (source)
ParametersiteratorAn object which implements the iterator interface. (type: object)
containerDestination container. (type: Container)
object_nameObject name. (type: str)
extra(optional) Extra attributes (driver specific).

Note: This dictionary must contain a 'content_type' key which represents a content type of the stored object.

(type: dict)
def download_object(self, obj, destination_path, overwrite_existing=False, delete_on_failure=True): (source)
Download an object to the specified destination path.
ParametersobjObject instance. (type: Object)
destination_pathFull path to a file or a directory where the incoming file will be saved. (type: str)
overwrite_existingTrue to overwrite an existing file, defaults to False. (type: bool)
delete_on_failureTrue to delete a partially downloaded file if the download was not successful (hash mismatch / file size). (type: bool)
ReturnsTrue if an object has been successfully downloaded, False otherwise. (type: bool)
def download_object_as_stream(self, obj, chunk_size=None): (source)
Return a generator which yields object data.
ParametersobjObject instance (type: Object)
chunk_sizeOptional chunk size (in bytes). (type: int)
def delete_object(self, obj): (source)
Delete an object.
ParametersobjObject instance. (type: Object)
Returnsbool True on success.
def list_container_objects(self, container): (source)
Return a list of objects for the given container.
ParameterscontainerContainer instance (type: Container)
ReturnsA list of Object instances.
def enable_object_cdn(self, obj): (source)
Undocumented
def get_object_cdn_url(self, obj, expiry=None, use_object=False): (source)
Return a container CDN URL.
ParametersobjObject instance (type: Object)
ReturnsA CDN URL for this object.
def _cdn_signature(self, path, params): (source)
Undocumented
def _list_objects(self, tree, object_type=None): (source)
Undocumented
def _namespace_path(self, path): (source)
Undocumented
def _object_path(self, object_id): (source)
Undocumented
@staticmethod
def _emc_tag(tag): (source)
Undocumented
def _emc_meta(self, response): (source)
Undocumented
def _get_more(self, last_key, value_dict): (source)
Undocumented
API Documentation for libcloud, generated by pydoctor at 2012-07-15 18:45:43.