You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by bu...@apache.org on 2011/11/05 01:53:51 UTC
svn commit: r798097 - in /websites/staging/libcloud/trunk/content/docs:
storage-base-api.html storage-overview.html
Author: buildbot
Date: Sat Nov 5 00:53:51 2011
New Revision: 798097
Log:
Staging update by buildbot
Added:
websites/staging/libcloud/trunk/content/docs/storage-base-api.html
websites/staging/libcloud/trunk/content/docs/storage-overview.html
Added: websites/staging/libcloud/trunk/content/docs/storage-base-api.html
==============================================================================
--- websites/staging/libcloud/trunk/content/docs/storage-base-api.html (added)
+++ websites/staging/libcloud/trunk/content/docs/storage-base-api.html Sat Nov 5 00:53:51 2011
@@ -0,0 +1,186 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+ <title>Storage -> Base API | Apache Libcloud Documentation</title>
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js" type="text/javascript"></script>
+ <script src="http://ajax.googleapis.com/ajax/libs/jqueryui/1.7.2/jquery-ui.min.js" type="text/javascript"></script>
+ <script src="/js/clearlink.js" type="text/javascript"></script>
+ <script src="/js/libcloud.js" type="text/javascript"></script>
+ <link rel="stylesheet" href="/css/screen.css" type="text/css">
+ <link rel="stylesheet" href="/css/libcloud.css" type="text/css">
+ <link rel="stylesheet" href="/css/documentation.css" type="text/css">
+ <link rel="stylesheet" href="/css/code.css" type="text/css">
+ <link rel="icon" type="image/png" href="/images/favicon.png"/>
+</head>
+<body>
+ <div class="container">
+ <div id="header" class="span-24 last">
+
+ <h1>Apache Libcloud <span>a unified interface to the cloud</span></h1>
+
+ </div>
+
+ <div id="banner" class="span-24 last">
+
+ <h2>Libcloud
+ Documentation: Storage -> Base API</h2>
+
+ </div>
+
+
+ <div id="sidebar" class="span-6 border">
+
+<ul id="menu">
+ <li><a href="/index.html">Website home</a></li>
+ <li><a href="/docs/index.html">Documentation home</a></li>
+ <li><a href="/docs/components.html">Components</a></li>
+ <ul>
+ <li class="title">Compute</li>
+ <ul>
+ <li><a href="compute-overview.html">Overview</a></li>
+ <li><a href="compute-base-api.html">Base API</a></li>
+ <li><a href="compute-deployment.html">Deployment</a></li>
+ </ul>
+ <li class="title">Storage</li>
+ <ul>
+ <li><a href="storage-overview.html">Storage</a></li>
+ <li><a href="storage-base-api.html">Base API</a></li>
+ </ul>
+ <li class="title">Load Balancer</li>
+ </ul>
+ <li>Other</li>
+ <ul>
+ <ul>
+ <li><a href="debugging.html">Debugging</a></li>
+ <li><a href="using-libcloud-in-multi-threaded-and-async-environments.html">Using Libcloud in multi-threaded and async environments</a></li>
+ </ul>
+ </ul>
+ <li><a href="/apidocs">Generated API docs</a></li>
+</ul>
+
+
+
+ </div>
+
+
+ <div id="main" class="span-16 last">
+
+ <h2 id="base_api">Base API</h2>
+<ul>
+<li><a href="#containers">list_containers</a></li>
+<li><a href="#list_container_object">list_container_object</a></li>
+<li><a href="#get_container">get_container</a></li>
+<li><a href="#get_object">get_object</a></li>
+<li><a href="#create_container">create_container</a></li>
+<li><a href="#upload_object">upload_object</a></li>
+<li><a href="#upload_object_via_stream">upload_object_via_stream</a></li>
+<li><a href="#download_object">download_object</a></li>
+<li><a href="#download_object_as_stream">download_object_as_stream</a></li>
+<li><a href="#delete_container">delete_container</a></li>
+<li><a href="#delete_object">delete_object</a></li>
+</ul>
+<h3 id="list_containers">list_containers</h3>
+
+<p><strong>Method signature</strong>:
+<a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#list_containters">driver.list_containters()</a><br />
+<strong>Description</strong>: Return a list of all the containers belonging to your account.
+The returned object is actually an instance of <code>LazyList</code> class which implements
+an iterator interface and transparently handles pagination for you.<br />
+</p>
+<h3 id="list_container_object">list_container_object</h3>
+
+<p><a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#list_container_object">driver.list_container_object()</a><br />
+<strong>Description</strong>: Return a list of all the object inside the container.
+Similar to the list_containers this method also returns a <code>LazyList</code> instance.<br />
+</p>
+<h3 id="get_container">get_container></h3>
+
+<p><a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#get_container">driver.get_container(container_name)</a><br />
+<strong>Description</strong>: Return a <code>Container</code> instance. This method is useful if you
+know the container name and want perform operations on it. Usually it is also
+more efficient then calling <code>list_containers()</code> and manually iterating over the
+list to find the container you are interested in.</p>
+<h3 id="get_object">get_object</h3>
+
+<p><a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#get_container">driver.get_container(container_name, object_name)</a><br />
+<strong>Description</strong>: Return an <code>Object</code> instance. Similar to the <code>get_container</code>
+this method is also useful if you know the name of the object and the container
+holding this object and you want to perform operations on it.</p>
+<h3 id="create_container">create_container</h3>
+
+<p><a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#create_container">driver.create_container(container_name)</a><br />
+<strong>Description</strong>: Create a new container.</p>
+<h3 id="upload_object">upload_object</h3>
+
+<p><a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#upload_object">driver.upload_object(file_path, container, object_name, extra=None, verify_hash)</a>,
+<a href="/apidocs/current/libcloud.storage.base.Container.html#upload_object">container.upload_object(file_path, object_name, extra=None, verify_hash)</a><br />
+<strong>Description</strong>: Upload a file stored on a disk.</p>
+<h3 id="upload_object_via_stream">upload_object_via_stream</h3>
+
+<p><a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#upload_object_via_stream">driver.upload_object_via_stream(iterator, container, object_name, extra)</a>,
+<a href="/apidocs/current/libcloud.storage.base.Container.html#upload_object_via_stream">container.upload_object_via_stream(file_path, object_name, extra=None, verify_hash)</a><br />
+<strong>Description</strong>: Upload an object using an iterator. If a provider supports
+chunked transfer encoding this method doesn't require you to know the object
+size in advance. This allows you to directly stream data to the provider without
+buffering it on disk.</p>
+<p>Good example of this are backups - you can directly stream tar output to the
+provider without buffering or temporary storing data on the disk.</p>
+<p><strong>Note: If the provider doesn't support chunked transfer encoding this function
+will first exhaust your iterator to determine the file size and then send it to
+the provider. Exhausting the iterator means that the whole iterator content
+must be buffered in the memory which might lead to the resource exhaustion.</strong></p>
+<h3 id="download_object">download_object</h3>
+
+<p><a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#download_object">driver.download_object(obj, destination_path, overwrite_existing, delete_on_failure)</a>,
+<a href="/apidocs/current/libcloud.storage.base.Container.html#download_object">container.download_object(obj, destination_path, overwrite_existing, delete_on_failure)</a>,
+<a href="/apidocs/current/libcloud.storage.base.Object.html#download_object">object.download(destination_path, overwrite_existing, delete_on_failure)</a><br />
+<strong>Description</strong>: Download an object and save it to a file on disk.</p>
+<h3 id="download_object_as_stream">download_object_as_stream</h3>
+
+<p><a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#download_object_as_stream">driver.download_object_as_stream(obj, chunk_size)</a>,
+<a href="/apidocs/current/libcloud.storage.base.Container.html#download_object_as_stream">container.download_object_as_stream(obj, chunk_size)</a>,
+<a href="/apidocs/current/libcloud.storage.base.Object.html#as_stream">object.as_stream(chunk_size)</a><br />
+<strong>Description</strong>: Return a generator which yields object data. This method is
+useful if you don't want to directly save object on disk and want to perform
+some other operations with it.</p>
+<h3 id="delete_container">delete_container</h3>
+
+<p><a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#delete_container">driver.delete_container(container)</a>,
+<a href="/apidocs/current/libcloud.storage.base.Container.html#delete">container.delete()</a><br />
+<strong>Description</strong>: Delete a container.</p>
+<h3 id="delete_object">delete_object</h3>
+
+<p><a href="/apidocs/current/libcloud.storage.base.StorageDriver.html#delete_object">driver.delete_object(obj)</a>,
+<a href="/apidocs/current/libcloud.storage.base.Container.html#delete_object">container.delete_object(obj)</a>,
+<a href="/apidocs/current/libcloud.storage.base.Object.html#delete">object.delete()</a><br />
+<strong>Description</strong>: Delete an object.</p>
+
+ </div>
+
+ <div id="footer" class="span-24">
+ <a href="http://www.apache.org/licenses/">License</a> | <a
+ href="/security.html">Security</a> | <a
+ href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> |
+<a href="http://www.apache.org/foundation/thanks.html">Thanks</a> | <a
+ href="/credits.html">Credits</a> | <a href="/sitemap.html">Sitemap</a><br /><br />
+
+Copyright © 2009-2011, <a href="http://apache.org/">The Apache Software Foundation</a><br />
+Apache Libcloud, Libcloud, Apache, the Apache feather, and the Apache Libcloud
+project logo are trademarks of the Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+
+ </div>
+ </div>
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-23580482-1");
+pageTracker._trackPageview();
+} catch(err) {}
+</script>
+
+</body>
+</html>
Added: websites/staging/libcloud/trunk/content/docs/storage-overview.html
==============================================================================
--- websites/staging/libcloud/trunk/content/docs/storage-overview.html (added)
+++ websites/staging/libcloud/trunk/content/docs/storage-overview.html Sat Nov 5 00:53:51 2011
@@ -0,0 +1,108 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+ <title>Storage -> Overview | Apache Libcloud Documentation</title>
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js" type="text/javascript"></script>
+ <script src="http://ajax.googleapis.com/ajax/libs/jqueryui/1.7.2/jquery-ui.min.js" type="text/javascript"></script>
+ <script src="/js/clearlink.js" type="text/javascript"></script>
+ <script src="/js/libcloud.js" type="text/javascript"></script>
+ <link rel="stylesheet" href="/css/screen.css" type="text/css">
+ <link rel="stylesheet" href="/css/libcloud.css" type="text/css">
+ <link rel="stylesheet" href="/css/documentation.css" type="text/css">
+ <link rel="stylesheet" href="/css/code.css" type="text/css">
+ <link rel="icon" type="image/png" href="/images/favicon.png"/>
+</head>
+<body>
+ <div class="container">
+ <div id="header" class="span-24 last">
+
+ <h1>Apache Libcloud <span>a unified interface to the cloud</span></h1>
+
+ </div>
+
+ <div id="banner" class="span-24 last">
+
+ <h2>Libcloud
+ Documentation: Storage -> Overview</h2>
+
+ </div>
+
+
+ <div id="sidebar" class="span-6 border">
+
+<ul id="menu">
+ <li><a href="/index.html">Website home</a></li>
+ <li><a href="/docs/index.html">Documentation home</a></li>
+ <li><a href="/docs/components.html">Components</a></li>
+ <ul>
+ <li class="title">Compute</li>
+ <ul>
+ <li><a href="compute-overview.html">Overview</a></li>
+ <li><a href="compute-base-api.html">Base API</a></li>
+ <li><a href="compute-deployment.html">Deployment</a></li>
+ </ul>
+ <li class="title">Storage</li>
+ <ul>
+ <li><a href="storage-overview.html">Storage</a></li>
+ <li><a href="storage-base-api.html">Base API</a></li>
+ </ul>
+ <li class="title">Load Balancer</li>
+ </ul>
+ <li>Other</li>
+ <ul>
+ <ul>
+ <li><a href="debugging.html">Debugging</a></li>
+ <li><a href="using-libcloud-in-multi-threaded-and-async-environments.html">Using Libcloud in multi-threaded and async environments</a></li>
+ </ul>
+ </ul>
+ <li><a href="/apidocs">Generated API docs</a></li>
+</ul>
+
+
+
+ </div>
+
+
+ <div id="main" class="span-16 last">
+
+ <h2 id="overview">Overview</h2>
+<p>Storage API allows you to manage cloud storage and services such as Amazon S3,
+Rackspace CloudFiles, Google Storage and <a href="/supported_providers.html">others</a>.</p>
+<h3 id="terminology">Terminology</h3>
+<ul>
+<li><strong>Object</strong> - represents an object or so called BLOB.</li>
+<li><strong>Container</strong> - represents a container which can contain multiple objects. You
+can think of it as a folder on a file system. Difference between container and a
+folder on file system is that containers cannot be nested. Some APIs also call
+it a <strong>Bucket</strong>.</li>
+</ul>
+
+ </div>
+
+ <div id="footer" class="span-24">
+ <a href="http://www.apache.org/licenses/">License</a> | <a
+ href="/security.html">Security</a> | <a
+ href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> |
+<a href="http://www.apache.org/foundation/thanks.html">Thanks</a> | <a
+ href="/credits.html">Credits</a> | <a href="/sitemap.html">Sitemap</a><br /><br />
+
+Copyright © 2009-2011, <a href="http://apache.org/">The Apache Software Foundation</a><br />
+Apache Libcloud, Libcloud, Apache, the Apache feather, and the Apache Libcloud
+project logo are trademarks of the Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+
+ </div>
+ </div>
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-23580482-1");
+pageTracker._trackPageview();
+} catch(err) {}
+</script>
+
+</body>
+</html>