You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2011/11/09 03:26:00 UTC
svn commit: r1199599 [26/32] - in /libcloud/site/trunk/content/apidocs: ./
0.6.1/
Added: libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.Container.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.Container.html?rev=1199599&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.Container.html (added)
+++ libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.Container.html Wed Nov 9 02:25:35 2011
@@ -0,0 +1,364 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.base.Container : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.b.Container(<span title="object">object</span>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L95">View Source</a>
+ <a href="classIndex.html#libcloud.storage.base.Container">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <pre>Represents a container (bucket) which can hold multiple objects.</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id495">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#__init__">__init__</a></td>
+ <td><tt>@type name: C{str} @param name: Container name (must be unique).</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#list_objects">list_objects</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#get_cdn_url">get_cdn_url</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#enable_cdn">enable_cdn</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#get_object">get_object</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#upload_object">upload_object</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#upload_object_via_stream">upload_object_via_stream</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#download_object">download_object</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#download_object_as_stream">download_object_as_stream</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#delete_object">delete_object</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#delete">delete</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Container.html#__repr__">__repr__</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.base.Container.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, name, extra, driver):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L100" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>@type name: C{str}
+@param name: Container name (must be unique).
+
+@type extra: C{dict}
+@param extra: Extra attributes.
+
+@type driver: C{StorageDriver}
+@param driver: StorageDriver instance.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.list_objects">
+
+ </a>
+ <a name="list_objects">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ list_objects(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L116" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.get_cdn_url">
+
+ </a>
+ <a name="get_cdn_url">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_cdn_url(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L119" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.enable_cdn">
+
+ </a>
+ <a name="enable_cdn">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ enable_cdn(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L122" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.get_object">
+
+ </a>
+ <a name="get_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_object(self, object_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L125" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.upload_object">
+
+ </a>
+ <a name="upload_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ upload_object(self, file_path, object_name, extra=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L129" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.upload_object_via_stream">
+
+ </a>
+ <a name="upload_object_via_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ upload_object_via_stream(self, iterator, object_name, extra=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L133" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.download_object">
+
+ </a>
+ <a name="download_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download_object(self, obj, destination_path, overwrite_existing=False, delete_on_failure=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L137" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.download_object_as_stream">
+
+ </a>
+ <a name="download_object_as_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download_object_as_stream(self, obj, chunk_size=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L141" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.delete_object">
+
+ </a>
+ <a name="delete_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete_object(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L144" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.delete">
+
+ </a>
+ <a name="delete">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L147" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Container.__repr__">
+
+ </a>
+ <a name="__repr__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __repr__(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L150" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2011-11-09 03:18:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.Object.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.Object.html?rev=1199599&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.Object.html (added)
+++ libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.Object.html Wed Nov 9 02:25:35 2011
@@ -0,0 +1,246 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.base.Object : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.b.Object(<span title="object">object</span>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L35">View Source</a>
+ <a href="classIndex.html#libcloud.storage.base.Object">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <pre>Represents an object (BLOB).</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id494">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Object.html#__init__">__init__</a></td>
+ <td><tt>@type name: C{str} @param name: Object name (must be unique per container).</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Object.html#get_cdn_url">get_cdn_url</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Object.html#enable_cdn">enable_cdn</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Object.html#download">download</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Object.html#as_stream">as_stream</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Object.html#delete">delete</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.Object.html#__repr__">__repr__</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.base.Object.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, name, size, hash, extra, meta_data, container, driver):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L40" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>@type name: C{str}
+@param name: Object name (must be unique per container).
+
+@type size: C{int}
+@param size: Object size in bytes.
+
+@type hash: C{string}
+@param hash Object hash.
+
+@type container: C{Container}
+@param container: Object container.
+
+@type extra: C{dict}
+@param extra: Extra attributes.
+
+@type meta_data: C{dict}
+@param meta_data: Optional object meta data.
+
+@type driver: C{StorageDriver}
+@param driver: StorageDriver instance.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Object.get_cdn_url">
+
+ </a>
+ <a name="get_cdn_url">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_cdn_url(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L73" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Object.enable_cdn">
+
+ </a>
+ <a name="enable_cdn">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ enable_cdn(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L76" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Object.download">
+
+ </a>
+ <a name="download">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download(self, destination_path, overwrite_existing=False, delete_on_failure=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L79" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Object.as_stream">
+
+ </a>
+ <a name="as_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ as_stream(self, chunk_size=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L85" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Object.delete">
+
+ </a>
+ <a name="delete">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L88" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.Object.__repr__">
+
+ </a>
+ <a name="__repr__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __repr__(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L91" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2011-11-09 03:18:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.StorageDriver.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.StorageDriver.html?rev=1199599&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.StorageDriver.html (added)
+++ libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.StorageDriver.html Wed Nov 9 02:25:35 2011
@@ -0,0 +1,884 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.base.StorageDriver : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.b.StorageDriver(<a href="libcloud.common.base.BaseDriver.html">BaseDriver</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.base.html">base</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L154">View Source</a>
+ <a href="classIndex.html#libcloud.storage.base.StorageDriver">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></p>
+ </div>
+ <pre>A base StorageDriver to derive from.</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id496">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#__init__">__init__</a></td>
+ <td><tt>@keyword key: API key or username to used @type key: str</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#list_containters">list_containters</a></td>
+ <td><tt>Return a list of containers.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#list_container_objects">list_container_objects</a></td>
+ <td><tt>Return a list of objects for the given container.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#get_container">get_container</a></td>
+ <td><tt>Return a container instance.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#get_container_cdn_url">get_container_cdn_url</a></td>
+ <td><tt>Return a container CDN URL.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#get_object">get_object</a></td>
+ <td><tt>Return an object instance.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#get_object_cdn_url">get_object_cdn_url</a></td>
+ <td><tt>Return a container CDN URL.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#enable_container_cdn">enable_container_cdn</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#enable_object_cdn">enable_object_cdn</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#download_object">download_object</a></td>
+ <td><tt>Download an object to the specified destination path.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#download_object_as_stream">download_object_as_stream</a></td>
+ <td><tt>Return a generator which yields object data.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#upload_object">upload_object</a></td>
+ <td><tt>Upload an object currently located on a disk.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#upload_object_via_stream">upload_object_via_stream</a></td>
+ <td><tt>Upload an object using an iterator.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#delete_object">delete_object</a></td>
+ <td><tt>Delete an object.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#create_container">create_container</a></td>
+ <td><tt>Create a new container.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#delete_container">delete_container</a></td>
+ <td><tt>Delete a container.</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_get_object">_get_object</a></td>
+ <td><tt>Call passed callback and start transfer of the object'</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_save_object">_save_object</a></td>
+ <td><tt>Save object to the provided path.</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_object">_upload_object</a></td>
+ <td><tt>Helper function for setting common request headers and calling the passed in callback which uploads an object.</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_data">_upload_data</a></td>
+ <td><tt>Upload data stored in a string.</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_stream_data">_stream_data</a></td>
+ <td><tt>Stream a data over an http connection.</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_file">_upload_file</a></td>
+ <td><tt>Upload a file to the server.</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_get_hash_function">_get_hash_function</a></td>
+ <td><tt>Return instantiated hash function for the hash type supported by the provider.</tt></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.BaseDriver.html">BaseDriver</a>:
+ </p>
+ <table class="children sortable" id="id497">
+
+
+<tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.BaseDriver.html#_ex_connection_class_kwargs">_ex_connection_class_kwargs</a></td>
+ <td><tt>Return extra connection keyword arguments which are passed to the Connection class constructor.</tt></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.base.StorageDriver.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, key, secret=None, secure=True, host=None, port=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L164" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.common.base.BaseDriver.html#__init__">libcloud.common.base.BaseDriver.__init__</a></div><div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a></div>
+ <pre>@keyword key: API key or username to used
+@type key: str
+
+@keyword secret: Secret password to be used
+@type secret: str
+
+@keyword secure: Weither to use HTTPS or HTTP. Note: Some providers
+ only support HTTPS, and it is on by default.
+@type secure: bool
+
+@keyword host: Override hostname used for connections.
+@type host: str
+
+@keyword port: Override port used for connections.
+@type port: int
+
+@keyword api_version: Optional API version. Only used by drivers
+ which support multiple API versions.
+@type api_version: str</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.list_containters">
+
+ </a>
+ <a name="list_containters">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ list_containters(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L168" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>Return a list of containers.
+
+@return: A list of Container instances.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.list_container_objects">
+
+ </a>
+ <a name="list_container_objects">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ list_container_objects(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L177" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <pre>Return a list of objects for the given container.
+
+@type container: C{Container}
+@param container: Container instance
+
+@return: A list of Object instances.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.get_container">
+
+ </a>
+ <a name="get_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_container(self, container_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L189" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <pre>Return a container instance.
+
+@type container_name: C{str}
+@param container_name: Container name.
+
+@return: C{Container} instance.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.get_container_cdn_url">
+
+ </a>
+ <a name="get_container_cdn_url">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_container_cdn_url(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L201" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a></div>
+ <pre>Return a container CDN URL.
+
+@type container: C{Container}
+@param container: Container instance
+
+@return: A CDN URL for this container.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.get_object">
+
+ </a>
+ <a name="get_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_object(self, container_name, object_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L213" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <pre>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.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.get_object_cdn_url">
+
+ </a>
+ <a name="get_object_cdn_url">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_object_cdn_url(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L228" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a></div>
+ <pre>Return a container CDN URL.
+
+@type obj: C{Object}
+@param obj: Object instance
+
+@return: A CDN URL for this object.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.enable_container_cdn">
+
+ </a>
+ <a name="enable_container_cdn">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ enable_container_cdn(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L240" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a></div>
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.enable_object_cdn">
+
+ </a>
+ <a name="enable_object_cdn">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ enable_object_cdn(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L244" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a></div>
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.download_object">
+
+ </a>
+ <a name="download_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download_object(self, obj, destination_path, overwrite_existing=False, delete_on_failure=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L248" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <pre>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.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.download_object_as_stream">
+
+ </a>
+ <a name="download_object_as_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download_object_as_stream(self, obj, chunk_size=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L273" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <pre>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).</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.upload_object">
+
+ </a>
+ <a name="upload_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ upload_object(self, file_path, container, object_name, extra=None, verify_hash=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L286" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <pre>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).</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.upload_object_via_stream">
+
+ </a>
+ <a name="upload_object_via_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ upload_object_via_stream(self, iterator, container, object_name, extra=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L306" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <pre>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.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.delete_object">
+
+ </a>
+ <a name="delete_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete_object(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L344" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <pre>Delete an object.
+
+@type obj: C{Object}
+@param obj: Object instance.
+
+@return: C{bool} True on success.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.create_container">
+
+ </a>
+ <a name="create_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ create_container(self, container_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L356" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <pre>Create a new container.
+
+@type container_name: C{str}
+@param container_name: Container name.
+
+@return: C{Container} instance on success.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver.delete_container">
+
+ </a>
+ <a name="delete_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete_container(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L368" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overridden in <a href="libcloud.storage.drivers.atmos.AtmosDriver.html">libcloud.storage.drivers.atmos.AtmosDriver</a>, <a href="libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver.html">libcloud.storage.drivers.cloudfiles.CloudFilesStorageDriver</a>, <a href="libcloud.storage.drivers.dummy.DummyStorageDriver.html">libcloud.storage.drivers.dummy.DummyStorageDriver</a>, <a href="libcloud.storage.drivers.s3.S3StorageDriver.html">libcloud.storage.drivers.s3.S3StorageDriver</a></div>
+ <pre>Delete a container.
+
+@type container: C{Container}
+@param container: Container instance
+
+@rtype: C{bool}
+@return: True on success, False otherwise.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._get_object">
+
+ </a>
+ <a name="_get_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _get_object(self, obj, callback, callback_kwargs, response, success_status_code=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L381" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>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)
+
+@rtype: C{bool}
+@return: True on success, False otherwise.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._save_object">
+
+ </a>
+ <a name="_save_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _save_object(self, response, obj, destination_path, overwrite_existing=False, delete_on_failure=True, chunk_size=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L417" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>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)
+
+@rtype: C{bool}
+@return: True on success, False otherwise.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._upload_object">
+
+ </a>
+ <a name="_upload_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _upload_object(self, object_name, content_type, upload_func, upload_func_kwargs, request_path, request_method='PUT', headers=None, file_path=None, iterator=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L498" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>Helper function for setting common request headers and calling the
+passed in callback which uploads an object.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._upload_data">
+
+ </a>
+ <a name="_upload_data">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _upload_data(self, response, data, calculate_hash=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L563" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>Upload data stored in a string.
+
+@type response: C{RawResponse}
+@param response: RawResponse object.
+
+@type data: C{str}
+@param data: Data to upload.
+
+@type calculate_hash: C{boolean}
+@param calculate_hash: True to calculate hash of the transfered data.
+ (defauls to True).
+
+@rtype: C{tuple}
+@return: 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.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._stream_data">
+
+ </a>
+ <a name="_stream_data">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _stream_data(self, response, iterator, chunked=False, calculate_hash=True, chunk_size=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L603" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>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 chunked: C{boolean}
+@param chunked: True if the chunked transfer encoding should be used
+ (defauls to False).
+
+@type calculate_hash: C{boolean}
+@param calculate_hash: True to calculate hash of the transfered data.
+ (defauls to True).
+
+@type chunk_size: C{int}
+@param chunk_size: Optional chunk size (defaults to CHUNK_SIZE)
+
+@rtype: C{tuple}
+@return: 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.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._upload_file">
+
+ </a>
+ <a name="_upload_file">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _upload_file(self, response, file_path, chunked=False, calculate_hash=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L688" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>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.)
+
+@rtype: C{tuple}
+@return: 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.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.base.StorageDriver._get_hash_function">
+
+ </a>
+ <a name="_get_hash_function">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _get_hash_function(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py#L718" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <pre>Return instantiated hash function for the hash type supported by
+the provider.</pre>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2011-11-09 03:18:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.html?rev=1199599&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.html (added)
+++ libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.base.html Wed Nov 9 02:25:35 2011
@@ -0,0 +1,63 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.base : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="module">l.s.base : module documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/base.py">View Source</a>
+
+ </p>
+ <div>
+
+ </div>
+ <pre>Provides base classes for working with storage</pre>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id493">
+
+
+<tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.storage.base.Object.html">Object</a></td>
+ <td><tt>Represents an object (BLOB).</tt></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.storage.base.Container.html">Container</a></td>
+ <td><tt>Represents a container (bucket) which can hold multiple objects.</tt></td>
+ </tr><tr class="class">
+
+
+ <td>Class</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html">StorageDriver</a></td>
+ <td><tt>A base StorageDriver to derive from.</tt></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2011-11-09 03:18:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.__init__.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.__init__.html?rev=1199599&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.__init__.html (added)
+++ libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.__init__.html Wed Nov 9 02:25:35 2011
@@ -0,0 +1,40 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.drivers.__init__ : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="module">l.s.d.__init__ : module documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.drivers.html">drivers</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/__init__.py">View Source</a>
+
+ </p>
+ <div>
+
+ </div>
+ <pre>Drivers for working with different providers</pre>
+
+
+
+ <div id="splitTables">
+
+
+
+ </div>
+
+
+
+
+
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2011-11-09 03:18:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosConnection.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosConnection.html?rev=1199599&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosConnection.html (added)
+++ libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosConnection.html Wed Nov 9 02:25:35 2011
@@ -0,0 +1,123 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.drivers.atmos.AtmosConnection : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.d.a.AtmosConnection(<span title="libcloud.common.base.ConnectionUserAndKey">ConnectionUserAndKey</span>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.drivers.html">drivers</a>.<a href="libcloud.storage.drivers.atmos.html">atmos</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L59">View Source</a>
+ <a href="classIndex.html#libcloud.storage.drivers.atmos.AtmosConnection">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <div class="undocumented">Undocumented</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id504">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosConnection.html#add_default_headers">add_default_headers</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosConnection.html#pre_connect_hook">pre_connect_hook</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosConnection.html#_calculate_signature">_calculate_signature</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosConnection.add_default_headers">
+
+ </a>
+ <a name="add_default_headers">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ add_default_headers(self, headers):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L62" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosConnection.pre_connect_hook">
+
+ </a>
+ <a name="pre_connect_hook">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ pre_connect_hook(self, params, headers):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L75" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosConnection._calculate_signature">
+
+ </a>
+ <a name="_calculate_signature">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _calculate_signature(self, params, headers):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L80" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2011-11-09 03:18:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosDriver.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosDriver.html?rev=1199599&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosDriver.html (added)
+++ libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosDriver.html Wed Nov 9 02:25:35 2011
@@ -0,0 +1,799 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.drivers.atmos.AtmosDriver : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.d.a.AtmosDriver(<a href="libcloud.storage.base.StorageDriver.html">StorageDriver</a>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.drivers.html">drivers</a>.<a href="libcloud.storage.drivers.atmos.html">atmos</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L106">View Source</a>
+ <a href="classIndex.html#libcloud.storage.drivers.atmos.AtmosDriver">View In Hierarchy</a>
+ </p>
+ <div>
+ <p>Known subclasses: <a href="libcloud.storage.drivers.ninefold.NinefoldStorageDriver.html">libcloud.storage.drivers.ninefold.NinefoldStorageDriver</a></p>
+ </div>
+ <div class="undocumented">Undocumented</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id505">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#__init__">__init__</a></td>
+ <td><tt>@keyword key: API key or username to used @type key: str</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#list_containers">list_containers</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#get_container">get_container</a></td>
+ <td><tt>Return a container instance.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#create_container">create_container</a></td>
+ <td><tt>Create a new container.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#delete_container">delete_container</a></td>
+ <td><tt>Delete a container.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#get_object">get_object</a></td>
+ <td><tt>Return an object instance.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#upload_object">upload_object</a></td>
+ <td><tt>Upload an object currently located on a disk.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#upload_object_via_stream">upload_object_via_stream</a></td>
+ <td><tt>Upload an object using an iterator.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#download_object">download_object</a></td>
+ <td><tt>Download an object to the specified destination path.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#download_object_as_stream">download_object_as_stream</a></td>
+ <td><tt>Return a generator which yields object data.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#delete_object">delete_object</a></td>
+ <td><tt>Delete an object.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#list_container_objects">list_container_objects</a></td>
+ <td><tt>Return a list of objects for the given container.</tt></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#enable_object_cdn">enable_object_cdn</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#get_object_cdn_url">get_object_cdn_url</a></td>
+ <td><tt>Return a container CDN URL.</tt></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_cdn_signature">_cdn_signature</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_list_objects">_list_objects</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_namespace_path">_namespace_path</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_object_path">_object_path</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="staticmethod private">
+
+
+ <td>Static Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_emc_tag">_emc_tag</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_emc_meta">_emc_meta</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="method private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosDriver.html#_get_more">_get_more</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.storage.base.StorageDriver.html">StorageDriver</a>:
+ </p>
+ <table class="children sortable" id="id506">
+
+
+<tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#list_containters">list_containters</a></td>
+ <td><tt>Return a list of containers.</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#get_container_cdn_url">get_container_cdn_url</a></td>
+ <td><tt>Return a container CDN URL.</tt></td>
+ </tr><tr class="basemethod">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#enable_container_cdn">enable_container_cdn</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_get_object">_get_object</a></td>
+ <td><tt>Call passed callback and start transfer of the object'</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_save_object">_save_object</a></td>
+ <td><tt>Save object to the provided path.</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_object">_upload_object</a></td>
+ <td><tt>Helper function for setting common request headers and calling the passed in callback which uploads an object.</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_data">_upload_data</a></td>
+ <td><tt>Upload data stored in a string.</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_stream_data">_stream_data</a></td>
+ <td><tt>Stream a data over an http connection.</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_upload_file">_upload_file</a></td>
+ <td><tt>Upload a file to the server.</tt></td>
+ </tr><tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.base.StorageDriver.html#_get_hash_function">_get_hash_function</a></td>
+ <td><tt>Return instantiated hash function for the hash type supported by the provider.</tt></td>
+ </tr>
+
+</table>
+
+ <p>
+ Inherited from <a href="libcloud.common.base.BaseDriver.html">BaseDriver</a> (via <a href="libcloud.storage.base.StorageDriver.html">StorageDriver</a>):
+ </p>
+ <table class="children sortable" id="id507">
+
+
+<tr class="basemethod private">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.common.base.BaseDriver.html#_ex_connection_class_kwargs">_ex_connection_class_kwargs</a></td>
+ <td><tt>Return extra connection keyword arguments which are passed to the Connection class constructor.</tt></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, key, secret=None, secure=True, host=None, port=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L116" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#__init__">libcloud.storage.base.StorageDriver.__init__</a></div>
+ <pre>@keyword key: API key or username to used
+@type key: str
+
+@keyword secret: Secret password to be used
+@type secret: str
+
+@keyword secure: Weither to use HTTPS or HTTP. Note: Some providers
+ only support HTTPS, and it is on by default.
+@type secure: bool
+
+@keyword host: Override hostname used for connections.
+@type host: str
+
+@keyword port: Override port used for connections.
+@type port: int
+
+@keyword api_version: Optional API version. Only used by drivers
+ which support multiple API versions.
+@type api_version: str</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.list_containers">
+
+ </a>
+ <a name="list_containers">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ list_containers(self):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L120" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.get_container">
+
+ </a>
+ <a name="get_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_container(self, container_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L131" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#get_container">libcloud.storage.base.StorageDriver.get_container</a></div>
+ <pre>Return a container instance.
+
+@type container_name: C{str}
+@param container_name: Container name.
+
+@return: C{Container} instance.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.create_container">
+
+ </a>
+ <a name="create_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ create_container(self, container_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L145" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#create_container">libcloud.storage.base.StorageDriver.create_container</a></div>
+ <pre>Create a new container.
+
+@type container_name: C{str}
+@param container_name: Container name.
+
+@return: C{Container} instance on success.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.delete_container">
+
+ </a>
+ <a name="delete_container">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete_container(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L155" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#delete_container">libcloud.storage.base.StorageDriver.delete_container</a></div>
+ <pre>Delete a container.
+
+@type container: C{Container}
+@param container: Container instance
+
+@rtype: C{bool}
+@return: True on success, False otherwise.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.get_object">
+
+ </a>
+ <a name="get_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_object(self, container_name, object_name):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L166" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#get_object">libcloud.storage.base.StorageDriver.get_object</a></div>
+ <pre>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.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.upload_object">
+
+ </a>
+ <a name="upload_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ upload_object(self, file_path, container, object_name, extra=None, verify_hash=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L194" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#upload_object">libcloud.storage.base.StorageDriver.upload_object</a></div>
+ <pre>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).</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.upload_object_via_stream">
+
+ </a>
+ <a name="upload_object_via_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ upload_object_via_stream(self, iterator, container, object_name, extra=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L242" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#upload_object_via_stream">libcloud.storage.base.StorageDriver.upload_object_via_stream</a></div>
+ <pre>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.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.download_object">
+
+ </a>
+ <a name="download_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download_object(self, obj, destination_path, overwrite_existing=False, delete_on_failure=True):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L298" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#download_object">libcloud.storage.base.StorageDriver.download_object</a></div>
+ <pre>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.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.download_object_as_stream">
+
+ </a>
+ <a name="download_object_as_stream">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ download_object_as_stream(self, obj, chunk_size=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L314" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#download_object_as_stream">libcloud.storage.base.StorageDriver.download_object_as_stream</a></div>
+ <pre>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).</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.delete_object">
+
+ </a>
+ <a name="delete_object">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ delete_object(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L326" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#delete_object">libcloud.storage.base.StorageDriver.delete_object</a></div>
+ <pre>Delete an object.
+
+@type obj: C{Object}
+@param obj: Object instance.
+
+@return: C{bool} True on success.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.list_container_objects">
+
+ </a>
+ <a name="list_container_objects">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ list_container_objects(self, container):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L336" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#list_container_objects">libcloud.storage.base.StorageDriver.list_container_objects</a></div>
+ <pre>Return a list of objects for the given container.
+
+@type container: C{Container}
+@param container: Container instance
+
+@return: A list of Object instances.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.enable_object_cdn">
+
+ </a>
+ <a name="enable_object_cdn">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ enable_object_cdn(self, obj):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L340" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#enable_object_cdn">libcloud.storage.base.StorageDriver.enable_object_cdn</a></div>
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver.get_object_cdn_url">
+
+ </a>
+ <a name="get_object_cdn_url">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ get_object_cdn_url(self, obj, expiry=None, use_object=False):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L343" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+ <div class="interfaceinfo">overrides <a href="libcloud.storage.base.StorageDriver.html#get_object_cdn_url">libcloud.storage.base.StorageDriver.get_object_cdn_url</a></div>
+ <pre>Return a container CDN URL.
+
+@type obj: C{Object}
+@param obj: Object instance
+
+@return: A CDN URL for this object.</pre>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._cdn_signature">
+
+ </a>
+ <a name="_cdn_signature">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _cdn_signature(self, path, params):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L365" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._list_objects">
+
+ </a>
+ <a name="_list_objects">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _list_objects(self, tree, object_type=None):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L372" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._namespace_path">
+
+ </a>
+ <a name="_namespace_path">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _namespace_path(self, path):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L386" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._object_path">
+
+ </a>
+ <a name="_object_path">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _object_path(self, object_id):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L389" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._emc_tag">
+
+ </a>
+ <a name="_emc_tag">
+
+ </a>
+ <div class="functionHeader">
+ @staticmethod<br />
+ def
+ _emc_tag(tag):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L393" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._emc_meta">
+
+ </a>
+ <a name="_emc_meta">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _emc_meta(self, response):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L396" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div><div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosDriver._get_more">
+
+ </a>
+ <a name="_get_more">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ _get_more(self, last_key, value_dict):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L403" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2011-11-09 03:18:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file
Added: libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosError.html
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosError.html?rev=1199599&view=auto
==============================================================================
--- libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosError.html (added)
+++ libcloud/site/trunk/content/apidocs/0.6.1/libcloud.storage.drivers.atmos.AtmosError.html Wed Nov 9 02:25:35 2011
@@ -0,0 +1,71 @@
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html>
+ <head>
+ <title>libcloud.storage.drivers.atmos.AtmosError : API documentation</title>
+ <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
+ <link href="apidocs.css" type="text/css" rel="stylesheet" />
+
+
+ </head>
+ <body>
+ <h1 class="class">l.s.d.a.AtmosError(<span title="Exception">Exception</span>) : class documentation</h1>
+ <p>
+ <span id="part">Part of <a href="libcloud.html">libcloud</a>.<a href="libcloud.storage.html">storage</a>.<a href="libcloud.storage.drivers.html">drivers</a>.<a href="libcloud.storage.drivers.atmos.html">atmos</a></span>
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L39">View Source</a>
+ <a href="classIndex.html#libcloud.storage.drivers.atmos.AtmosError">View In Hierarchy</a>
+ </p>
+ <div>
+
+ </div>
+ <div class="undocumented">Undocumented</div>
+
+
+
+ <div id="splitTables">
+ <table class="children sortable" id="id500">
+
+
+<tr class="method">
+
+
+ <td>Method</td>
+ <td><a href="libcloud.storage.drivers.atmos.AtmosError.html#__init__">__init__</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr>
+
+</table>
+
+
+ </div>
+
+
+
+
+ <div class="function">
+ <a name="libcloud.storage.drivers.atmos.AtmosError.__init__">
+
+ </a>
+ <a name="__init__">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ __init__(self, code, message):
+ <a href="https://svn.apache.org/viewvc/libcloud/trunk/libcloud/storage/drivers/atmos.py#L40" class="functionSourceLink">
+
+ (source)
+ </a>
+ </div>
+ <div class="functionBody">
+
+ <div class="undocumented">Undocumented</div>
+ </div>
+</div>
+ <address>
+ <a href="index.html">API Documentation</a> for <a href="http://libcloud.apache.org">libcloud</a>, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2011-11-09 03:18:04.
+ </address>
+ </body>
+</html>
\ No newline at end of file