libcloud.storage.drivers.atmos.AtmosDriver : API documentation

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)

overrides libcloud.storage.base.StorageDriver.__init__

Parameters	key	API key or username to used (type: str)
	secret	Secret password to be used (type: str)
	secure	Weither to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default. (type: bool)
	host	Override hostname used for connections. (type: str)
	port	Override port used for connections. (type: int)
	api_version	Optional API version. Only used by drivers which support multiple API versions. (type: str)

def get_container(self, container_name): (source)

overrides libcloud.storage.base.StorageDriver.get_container

Return a container instance.

Parameters	container_name	Container name. (type: `str`)
Returns	`Container` instance.

def create_container(self, container_name): (source)

overrides libcloud.storage.base.StorageDriver.create_container

Create a new container.

Parameters	container_name	Container name. (type: `str`)
Returns	`Container` instance on success.

def delete_container(self, container): (source)

overrides libcloud.storage.base.StorageDriver.delete_container

Delete a container.

Parameters	container	Container instance (type: `Container`)
Returns	True on success, False otherwise. (type: `bool`)

def get_object(self, container_name, object_name): (source)

overrides libcloud.storage.base.StorageDriver.get_object

Return an object instance.

Parameters	container_name	Container name. (type: `str`)
	object_name	Object name. (type: `str`)
Returns	`Object` instance.

def upload_object(self, file_path, container, object_name, extra=None, verify_hash=True): (source)

overrides libcloud.storage.base.StorageDriver.upload_object

Upload an object.

Parameters	file_path	Path to the object on disk. (type: `str`)
	container	Destination container. (type: `Container`)
	object_name	Object name. (type: `str`)
	extra	(optional) Extra attributes (driver specific). (type: `dict`)

def upload_object_via_stream(self, iterator, container, object_name, extra=None): (source)

overrides libcloud.storage.base.StorageDriver.upload_object_via_stream

Parameters	iterator	An object which implements the iterator interface. (type: `object`)
	container	Destination container. (type: `Container`)
	object_name	Object 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)

overrides libcloud.storage.base.StorageDriver.download_object

Download an object to the specified destination path.

Parameters	obj	Object instance. (type: `Object`)
	destination_path	Full path to a file or a directory where the incoming file will be saved. (type: `str`)
	overwrite_existing	True to overwrite an existing file, defaults to False. (type: `bool`)
	delete_on_failure	True to delete a partially downloaded file if the download was not successful (hash mismatch / file size). (type: `bool`)
Returns	True if an object has been successfully downloaded, False otherwise. (type: `bool`)

def download_object_as_stream(self, obj, chunk_size=None): (source)

overrides libcloud.storage.base.StorageDriver.download_object_as_stream

Return a generator which yields object data.

Parameters	obj	Object instance (type: `Object`)
	chunk_size	Optional chunk size (in bytes). (type: `int`)

def delete_object(self, obj): (source)

overrides libcloud.storage.base.StorageDriver.delete_object

Delete an object.

Parameters	obj	Object instance. (type: `Object`)
Returns	`bool` True on success.

def list_container_objects(self, container): (source)

overrides libcloud.storage.base.StorageDriver.list_container_objects

Return a list of objects for the given container.

Parameters	container	Container instance (type: `Container`)
Returns	A list of Object instances.

def get_object_cdn_url(self, obj, expiry=None, use_object=False): (source)

overrides libcloud.storage.base.StorageDriver.get_object_cdn_url

Return a container CDN URL.

Parameters	obj	Object instance (type: `Object`)
Returns	A CDN URL for this object.

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