libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver : API documentation

def __init__(self, *args, **kwargs): (source)

overrides libcloud.storage.base.StorageDriver.__init__

overridden in libcloud.storage.drivers.cloudfiles.CloudFilesSwiftStorageDriver

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)
Unknown Field: requires	key, secret

def list_containers(self): (source)

overrides libcloud.storage.base.StorageDriver.list_containers

Return a list of containers.

Returns A list of Container instances.

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_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 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 get_container_cdn_url(self, container): (source)

overrides libcloud.storage.base.StorageDriver.get_container_cdn_url

Return a container CDN URL.

Parameters	container	Container instance (type: `Container`)
Returns	A CDN URL for this container.

def get_object_cdn_url(self, obj): (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.

def enable_container_cdn(self, container, ex_ttl=None): (source)

overrides libcloud.storage.base.StorageDriver.enable_container_cdn

Undocumented

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 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 upload_object(self, file_path, container, object_name, extra=None, verify_hash=True): (source)

overrides libcloud.storage.base.StorageDriver.upload_object

Upload an object.

Note: This will override file with a same name if it already exists.

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

overrides libcloud.storage.base.StorageDriver.upload_object_via_stream

Upload an object using an iterator.

If a provider supports it, chunked transfer encoding is used and you don't need to know in advance the amount of data to be uploaded.

Otherwise if a provider doesn't support it, iterator will be exhausted so a total size for data to be uploaded can be determined.

Note: Exhausting the iterator means that the whole data must be buffered in memory which might result in memory exhausting when uploading a very large object.

If a file is located on a disk you are advised to use upload_object function which uses fs.stat function to determine the file size and it doesn't need to buffer whole object in the memory.

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 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 ex_get_meta_data(self): (source)

Undocumented

def ex_multipart_upload_object(self, file_path, container, object_name, chunk_size=33554432, extra=None, verify_hash=True): (source)

Undocumented

def ex_enable_static_website(self, container, index_file='index.html'): (source)

Enable serving a static website.

Parameters index_file Name of the object which becomes an index page for every sub-directory in this container. (type: str)

def ex_set_error_page(self, container, file_name='error.html'): (source)

Set a custom error page which is displayed if file is not found and serving of a static website is enabled.

Parameters file_name Name of the object which becomes the error page. (type: str)

def _upload_object_part(self, container, object_name, part_number, iterator, verify_hash=True): (source)

Undocumented

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

Undocumented

def _get_more(self, last_key, value_dict): (source)

Undocumented

def _put_object(self, container, object_name, upload_func, upload_func_kwargs, extra=None, file_path=None, iterator=None, verify_hash=True): (source)

Undocumented

def _clean_container_name(self, name): (source)

Clean container name.

def _clean_object_name(self, name): (source)

Undocumented

def _to_container_list(self, response): (source)

Undocumented

def _to_object_list(self, response, container): (source)

Undocumented

def _headers_to_container(self, name, headers): (source)

Undocumented

def _headers_to_object(self, name, container, headers): (source)

Undocumented

def _ex_connection_class_kwargs(self): (source)

overrides libcloud.common.base.BaseDriver._ex_connection_class_kwargs

Return extra connection keyword arguments which are passed to the Connection class constructor.

Method	enable_object_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	_upload_data	Upload data stored in a string.
Method	_stream_data	Stream a data over an http connection.
Method	_upload_file	Upload a file to the server.
Method	_get_hash_function	Return instantiated hash function for the hash type supported by the provider.

Method	__init__
Method	list_containers	Return a list of containers.
Method	list_container_objects	Return a list of objects for the given container.
Method	get_container	Return a container instance.
Method	get_object	Return an object instance.
Method	get_container_cdn_url	Return a container CDN URL.
Method	get_object_cdn_url	Return a container CDN URL.
Method	enable_container_cdn	Undocumented
Method	create_container	Create a new container.
Method	delete_container	Delete a container.
Method	download_object	Download an object to the specified destination path.
Method	download_object_as_stream	Return a generator which yields object data.
Method	upload_object	Upload an object.
Method	upload_object_via_stream	Upload an object using an iterator.
Method	delete_object	Delete an object.
Method	ex_get_meta_data	Undocumented
Method	ex_multipart_upload_object	Undocumented
Method	ex_enable_static_website	Enable serving a static website.
Method	ex_set_error_page	Set a custom error page which is displayed if file is not found and serving of a static website is enabled.
Method	_upload_object_part	Undocumented
Method	_upload_object_manifest	Undocumented
Method	_get_more	Undocumented
Method	_put_object	Undocumented
Method	_clean_container_name	Clean container name.
Method	_clean_object_name	Undocumented
Method	_to_container_list	Undocumented
Method	_to_object_list	Undocumented
Method	_headers_to_container	Undocumented
Method	_headers_to_object	Undocumented
Method	_ex_connection_class_kwargs	Return extra connection keyword arguments which are passed to the Connection class constructor.

l.s.d.c.CloudFilesStorageDriver(StorageDriver, OpenStackDriverMixin) : class documentation