l.s.b.StorageDriver(object) : class documentation

Return a list of objects for the given container.

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

@return A list of Object instances.

Return a container instance.

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

@return: C{Container} instance.

Return a container CDN URL.

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

@return A CDN URL for this container.

Return an object instance.

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

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

@return: C{Object} instance.

Return a container CDN URL.

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

@return A CDN URL for this object.

Download an object to the specified destination path.

@type obj; C{Object}
@param obj: Object instance.

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

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

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

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

Return a generator which yields object data.

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

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

Upload an object.

@type file_path: C{str}
@param file_path: Path to the object on disk.

@type container: C{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).

@type verify_hash: C{boolean}
@param verify_hash: True to do a file integrity check.

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

@type container: C{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).

Delete an object.

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

@return: C{bool} True on success.

Create a new container.

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

@return C{Container} instance on success.

Delete a container.

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

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

Call passed callback and start transfer of the object'

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

@type callback: C{Function}
@param callback: Function which is called with the passed callback_kwargs

@type callback_kwargs: C{dict}
@param callback_kwargs: Keyword arguments which are passed to the callback.

@typed response: C{Response}
@param response: Response instance.

@type success_status_code: C{int}
@param success_status_code: Status code which represents a successful
                            transfer (defaults to httplib.OK)

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

Save object to the provided path.

@type response: C{RawResponse}
@param response: RawResponse instance.

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

@type destination_path: C{Str}
@param destination_path: Destination directory.

@type delete_on_failure: C{bool}
@param delete_on_failure: True to delete partially downloaded object if
                          the download fails.
@type overwrite_existing: C{bool}
@param overwrite_existing: True to overwrite a local path if it already
                           exists.

@type chunk_size: C{int}
@param chunk_size: Optional chunk size (defaults to L{libcloud.storage.base.CHUNK_SIZE}, 8kb)

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

Helper function for setting common request headers and calling the
passed in callback which uploads an object.

Stream a data over an http connection.

@type response: C{RawResponse}
@param response: RawResponse object.

@type iterator: C{}
@param response: An object which implements an iterator interface
                 or a File like object with read method.

@type chunk_size: C{int}
@param chunk_size: Optional chunk size (defaults to CHUNK_SIZE)

@return C{tuple} First item is a boolean indicator of success, second
                 one is the uploaded data MD5 hash and the third one
                 is the number of transferred bytes.

Upload a file to the server.

@type response: C{RawResponse}
@param response: RawResponse object.

@type file_path: C{str}
@param file_path: Path to a local file.

@type iterator: C{}
@param response: An object which implements an iterator interface (File
                 object, etc.)

@return C{tuple} First item is a boolean indicator of success, second
                 one is the uploaded data MD5 hash and the third one
                 is the number of transferred bytes.