<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The horizon.api.swift Module — Horizon 2012.2.3 documentation</title>
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/tweaks.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2012.2.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/jquery.tweet.js"></script>
<link rel="top" title="Horizon 2012.2.3 documentation" href="../../index.html" />
<link rel="up" title="Source Code Index" href="../autoindex.html" />
<link rel="next" title="The horizon.api.base Module" href="horizon.api.base.html" />
<link rel="prev" title="The horizon.api.quantum Module" href="horizon.api.quantum.html" />
</head>
<body>
<div id="header">
<h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
<ul id="navigation">
<li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
<li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
<li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
<li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
<li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
<li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
<li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="the-horizon-api-swift-module">
<h1>The <tt class="xref py py-mod docutils literal"><span class="pre">horizon.api.swift</span></tt> Module<a class="headerlink" href="#the-horizon-api-swift-module" title="Permalink to this headline">ΒΆ</a></h1>
<dl class="class">
<dt>
<em class="property">class </em><tt class="descclassname">horizon.api.swift.</tt><tt class="descname">Container</tt><big>(</big><em>apidict</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#Container"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">horizon.api.base.APIDictWrapper</span></tt></p>
</dd></dl>
<dl class="class">
<dt>
<em class="property">class </em><tt class="descclassname">horizon.api.swift.</tt><tt class="descname">PseudoFolder</tt><big>(</big><em>apidict</em>, <em>container_name</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#PseudoFolder"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">horizon.api.base.APIDictWrapper</span></tt></p>
<p>Wrapper to smooth out discrepencies between swift “subdir” items
and swift pseudo-folder objects.</p>
<dl class="attribute">
<dt>
<tt class="descclassname">PseudoFolder.</tt><tt class="descname">bytes</tt><a class="reference internal" href="../../_modules/horizon/api/swift.html#PseudoFolder.bytes"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<tt class="descclassname">PseudoFolder.</tt><tt class="descname">content_type</tt><a class="reference internal" href="../../_modules/horizon/api/swift.html#PseudoFolder.content_type"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt>
<tt class="descclassname">PseudoFolder.</tt><tt class="descname">name</tt><a class="reference internal" href="../../_modules/horizon/api/swift.html#PseudoFolder.name"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt>
<em class="property">class </em><tt class="descclassname">horizon.api.swift.</tt><tt class="descname">StorageObject</tt><big>(</big><em>apidict</em>, <em>container_name</em>, <em>orig_name=None</em>, <em>data=None</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#StorageObject"><span class="viewcode-link">[source]</span></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">horizon.api.base.APIDictWrapper</span></tt></p>
</dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_api</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_api"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_container_exists</tt><big>(</big><em>request</em>, <em>container_name</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_container_exists"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_copy_object</tt><big>(</big><em>request</em>, <em>orig_container_name</em>, <em>orig_object_name</em>, <em>new_container_name</em>, <em>new_object_name</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_copy_object"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_create_container</tt><big>(</big><em>request</em>, <em>name</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_create_container"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_create_subfolder</tt><big>(</big><em>request</em>, <em>container_name</em>, <em>folder_name</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_create_subfolder"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_delete_container</tt><big>(</big><em>request</em>, <em>name</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_delete_container"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_delete_object</tt><big>(</big><em>request</em>, <em>container_name</em>, <em>object_name</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_delete_object"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_filter_objects</tt><big>(</big><em>request</em>, <em>filter_string</em>, <em>container_name</em>, <em>prefix=None</em>, <em>marker=None</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_filter_objects"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_get_containers</tt><big>(</big><em>request</em>, <em>marker=None</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_get_containers"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_get_object</tt><big>(</big><em>request</em>, <em>container_name</em>, <em>object_name</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_get_object"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_get_objects</tt><big>(</big><em>request</em>, <em>container_name</em>, <em>prefix=None</em>, <em>marker=None</em>, <em>limit=None</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_get_objects"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_object_exists</tt><big>(</big><em>request</em>, <em>container_name</em>, <em>object_name</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_object_exists"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">swift_upload_object</tt><big>(</big><em>request</em>, <em>container_name</em>, <em>object_name</em>, <em>object_file</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#swift_upload_object"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
<dl class="function">
<dt>
<tt class="descclassname">horizon.api.swift.</tt><tt class="descname">wildcard_search</tt><big>(</big><em>string</em>, <em>q</em><big>)</big><a class="reference internal" href="../../_modules/horizon/api/swift.html#wildcard_search"><span class="viewcode-link">[source]</span></a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="horizon.api.quantum.html"
title="previous chapter">The <tt class="docutils literal docutils literal docutils literal"><span class="pre">horizon.api.quantum</span></tt> Module</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="horizon.api.base.html"
title="next chapter">The <tt class="docutils literal docutils literal docutils literal"><span class="pre">horizon.api.base</span></tt> Module</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/sourcecode/horizon/horizon.api.swift.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="horizon.api.base.html" title="The horizon.api.base Module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="horizon.api.quantum.html" title="The horizon.api.quantum Module"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">Horizon 2012.2.3 documentation</a> »</li>
<li><a href="../autoindex.html" accesskey="U">Source Code Index</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, OpenStack, LLC.
Last updated on Feb 08, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
