Part of libcloud.storage.drivers.s3 View Source View In Hierarchy
Known subclasses: libcloud.storage.drivers.google_storage.GoogleStorageDriver, libcloud.storage.drivers.s3.S3APNEStorageDriver, libcloud.storage.drivers.s3.S3APSEStorageDriver, libcloud.storage.drivers.s3.S3EUWestStorageDriver, libcloud.storage.drivers.s3.S3USWestOregonStorageDriver, libcloud.storage.drivers.s3.S3USWestStorageDriver
| 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 | 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 currently located on a disk. |
| Method | upload_object_via_stream | Upload an object using an iterator. |
| Method | delete_object | Delete an object. |
| Method | _clean_object_name | Undocumented |
| Method | _get_more | 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__ | @keyword key: API key or username to used @type key: str |
| 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 | _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. |
Inherited from BaseDriver (via StorageDriver):
| Method | _ex_connection_class_kwargs | Return extra connection keyword arguments which are passed to the Connection class constructor. |
Return a list of containers. @return: A list of Container instances.
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 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.
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
@rtype: C{bool}
@return: True on success, False otherwise.
Download an object to the specified destination path.
@type obj: C{Object}
@param obj: Object instance.
@type destination_path: C{str}
@param destination_path: Full path to a file or a directory where the
incoming file will be saved.
@type overwrite_existing: C{bool}
@param 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).
@rtype: C{bool}
@return: 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 currently located on a disk.
@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).
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: 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).
Note: This dictionary must contain a 'content_type' key which represents
a content type of the stored object.
Delete an object.
@type obj: C{Object}
@param obj: Object instance.
@return: C{bool} True on success.