libcloud.storage.drivers.s3.S3StorageDriver : API documentation

Method	list_containers	Undocumented
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	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	`@type iterator: C{object} @param iterator: An object which implements the iterator interface.`
Method	delete_object	`Delete an object.`
Method	_clean_object_name	Undocumented
Method	_put_object	Undocumented
Method	_to_containers	Undocumented
Method	_to_objs	Undocumented
Method	_to_container	Undocumented
Method	_headers_to_object	Undocumented
Method	_to_obj	Undocumented

Inherited from StorageDriver:

Method	__init__	Undocumented
Method	list_containters	Undocumented
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	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	_stream_data	`Stream a data over an http connection.`
Method	_upload_file	`Upload a file to the server.`

def list_container_objects(self, container): (source)

overrides libcloud.storage.base.StorageDriver.list_container_objects

Return a list of objects for the given container.

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

@return A list of Object instances.

def get_container(self, container_name): (source)

overrides libcloud.storage.base.StorageDriver.get_container

Return a container instance.

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

@return: C{Container} instance.

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

overrides libcloud.storage.base.StorageDriver.get_object

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.

def create_container(self, container_name): (source)

overrides libcloud.storage.base.StorageDriver.create_container

Create a new container.

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

@return C{Container} instance on success.

def delete_container(self, container): (source)

overrides libcloud.storage.base.StorageDriver.delete_container

Delete a container.

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

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

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.

@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.

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.

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

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

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

overrides libcloud.storage.base.StorageDriver.upload_object

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.

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

overrides libcloud.storage.base.StorageDriver.upload_object_via_stream

@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).

l.s.d.s.S3StorageDriver(StorageDriver) : class documentation