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

@param    key:    API key or username to be used (required)
@type     key:    C{str}

@param    secret: Secret password to be used (required)
@type     secret: C{str}

@param    secure: Weither to use HTTPS or HTTP. Note: Some providers
                    only support HTTPS, and it is on by default.
@type     secure: C{bool}

@param    host: Override hostname used for connections.
@type     host: C{str}

@param    port: Override port used for connections.
@type     port: C{int}

@param    api_version: Optional API version. Only used by drivers
                         which support multiple API versions.
@type     api_version: C{str}

@rtype: C{None}

Return a list of containers.

@return: A list of Container instances.
@rtype: C{list} of L{Container}

Return a list of objects for the given container.

@param container: Container instance
@type container: L{Container}

@return: A list of Object instances.
@rtype: C{list} of L{Object}

Return a container instance.

@param container_name: Container name.
@type container_name: C{str}

@return: L{Container} instance.
@rtype: L{Container}

Return an object instance.

@param container_name: Container name.
@type  container_name: C{str}

@param object_name: Object name.
@type  object_name: C{str}

@return: L{Object} instance.
@rtype: L{Object}

Return a container CDN URL.

@param container: Container instance
@type  container: L{Container}

@return: A CDN URL for this container.
@rtype: C{str}

Return a object CDN URL.

@param obj: Object instance
@type  obj: L{Object}

@return: A CDN URL for this object.
@rtype: C{str}

@inherits: L{StorageDriver.enable_container_cdn}

@param ex_ttl: cache time to live
@type ex_ttl: C{int}

Create a new container.

@type container_name: C{str}
@param container_name: Container name.

@return: C{Container} instance on success.
@rtype: L{Container}

Delete a container.

@type container: L{Container}
@param container: Container instance

@return: True on success, False otherwise.
@rtype: C{bool}

Download an object to the specified destination path.

@param obj: Object instance.
@type obj: L{Object}

@param destination_path: Full path to a file or a directory where the
                        incoming file will be saved.
@type destination_path: C{str}

@param overwrite_existing: True to overwrite an existing file,
    defaults to False.
@type overwrite_existing: C{bool}

@param delete_on_failure: True to delete a partially downloaded file if
the download was not successful (hash mismatch / file size).
@type delete_on_failure: C{bool}

@return: True if an object has been successfully downloaded, False
otherwise.
@rtype: C{bool}

Return a generator which yields object data.

@param obj: Object instance
@type obj: L{Object}

@param chunk_size: Optional chunk size (in bytes).
@type chunk_size: C{int}

@rtype: C{object}

Upload an object.

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

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.

@type iterator: C{object}
@param iterator: An object which implements the iterator interface.

@type container: L{Container}
@param container: Destination container.

@type object_name: C{str}
@param object_name: Object name.

@type extra: C{dict}
@param extra: (optional) Extra attributes (driver specific). Note:
    This dictionary must contain a 'content_type' key which represents
    a content type of the stored object.

@rtype: C{object}

Delete an object.

@type obj: L{Object}
@param obj: Object instance.

@return: C{bool} True on success.
@rtype: C{bool}

Purge edge cache for the specified object.

@param email: Email where a notification will be sent when the job
completes. (optional)
@type email: C{str}

Get meta data

@rtype: C{dict}

Enable serving a static website.

@param container: Container instance
@type container: L{Container}

@param index_file: Name of the object which becomes an index page for
every sub-directory in this container.
@type index_file: C{str}

@rtype: C{bool}

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

@param container: Container instance
@type container: L{Container}

@param file_name: Name of the object which becomes the error page.
@type file_name: C{str}

@rtype: C{bool}

Set the metadata header X-Account-Meta-Temp-URL-Key on your Cloud
Files account.

@param key: X-Account-Meta-Temp-URL-Key
@type key: C{str}

@rtype: C{bool}

Create a temporary URL to allow others to retrieve or put objects
in your Cloud Files account for as long or as short a time as you
wish.  This method is specifically for allowing users to retrieve
or update an object.

@param obj: The object that you wish to make temporarily public
@type obj: L{Object}

@param method: Which method you would like to allow, 'PUT' or 'GET'
@type method: C{str}

@param timeout: Time (in seconds) after which you want the TempURL
to expire.
@type timeout: C{int}

@rtype: C{bool}

Encode container name so it can be used as part of the HTTP request.

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