Google Git
Sign in
apache / deltacloud / release-1.1.0-rc1 / . / client / doc / DeltaCloud.html
blob: e70bb61d8a8075bb746377722882100ef45dfeb4 [file] [log] [blame]
<!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" xml:lang="en" lang="en">
<head>
<meta name="Content-Type" content="text/html; charset=utf-8" />
<title>Module: DeltaCloud</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="_index.html">Index (D)</a> &raquo;
<span class="title">DeltaCloud</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id ="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: DeltaCloud
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/deltacloud.rb<span class="defines">,<br />
doc/deltacloud.rb,<br /> doc/deltacloud.rb,<br /> doc/deltacloud.rb,<br /> doc/deltacloud.rb,<br /> doc/deltacloud.rb,<br /> doc/deltacloud.rb,<br /> lib/plain_formatter.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <a href="DeltaCloud/HWP.html" title="DeltaCloud::HWP (module)">HWP</a>, <a href="DeltaCloud/InstanceState.html" title="DeltaCloud::InstanceState (module)">InstanceState</a>, <a href="DeltaCloud/PlainFormatter.html" title="DeltaCloud::PlainFormatter (module)">PlainFormatter</a>
<strong class="classes">Classes:</strong> <a href="DeltaCloud/API.html" title="DeltaCloud::API (class)">API</a>, <a href="DeltaCloud/Documentation.html" title="DeltaCloud::Documentation (class)">Documentation</a>
</p>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#classes-class_method" title="classes (class method)">+ (Object) <strong>classes</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#define_class-class_method" title="define_class (class method)">+ (Object) <strong>define_class</strong>(name) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#driver_name-class_method" title="driver_name (class method)">+ (Object) <strong>driver_name</strong>(url) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Return a API driver for specified URL.</p></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#new-class_method" title="new (class method)">+ (DeltaCloud::API) <strong>new</strong>(user_name, password, api_url, &amp;block) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Get a new API client instance.</p></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<p class="signature first" id="classes-class_method">
+ (<tt>Object</tt>) <strong>classes</strong>
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/deltacloud.rb', line 53</span>
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='classes identifier id'>classes</span>
<span class='puts identifier id'>puts</span> <span class='dstring node'>&quot;----&gt; \n#{@defined_classes.join(',')}\n&quot;</span>
<span class='@defined_classes ivar id'>@defined_classes</span> <span class='orop op'>||</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="define_class-class_method">
+ (<tt>Object</tt>) <strong>define_class</strong>(name)
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45
46
47
48
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/deltacloud.rb', line 43</span>
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='define_class identifier id'>define_class</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span>
<span class='@defined_classes ivar id'>@defined_classes</span> <span class='opasgn op'>||=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
<span class='if if kw'>if</span> <span class='@defined_classes ivar id'>@defined_classes</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span>
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='module_eval identifier id'>module_eval</span><span class='lparen token'>(</span><span class='dstring node'>&quot;API::#{name}&quot;</span><span class='rparen token'>)</span>
<span class='else else kw'>else</span>
<span class='@defined_classes ivar id'>@defined_classes</span> <span class='lshft op'>&lt;&lt;</span> <span class='name identifier id'>name</span> <span class='unless unless_mod kw'>unless</span> <span class='@defined_classes ivar id'>@defined_classes</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span>
<span class='API constant id'>API</span><span class='dot token'>.</span><span class='const_set identifier id'>const_set</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='Class constant id'>Class</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="driver_name-class_method">
+ (<tt>Object</tt>) <strong>driver_name</strong>(url)
</p><div class="docstring">
<div class="discussion">
<p>Return a API driver for specified URL</p>
</div>
</div>
<div class="tags">
<h3>Parameters:</h3>
<ul class="param">
<li>
<span class='type'>(<tt><a href="String.html" title="String (class)">String</a></tt>, <tt>url</tt>)</span>
<span class='name'>API</span>
&mdash;
<div class='inline'><p>URL (eg. http://localhost:3001/api)</p></div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/deltacloud.rb', line 39</span>
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='driver_name identifier id'>driver_name</span><span class='lparen token'>(</span><span class='url identifier id'>url</span><span class='rparen token'>)</span>
<span class='API constant id'>API</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='url identifier id'>url</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='driver_name identifier id'>driver_name</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="new-class_method">
+ (<tt><a href="DeltaCloud/API.html" title="DeltaCloud::API (class)">DeltaCloud::API</a></tt>) <strong>new</strong>(user_name, password, api_url, &amp;block)
</p><div class="docstring">
<div class="discussion">
<p>Get a new API client instance</p>
</div>
</div>
<div class="tags">
<h3>Parameters:</h3>
<ul class="param">
<li>
<span class='type'>(<tt><a href="String.html" title="String (class)">String</a></tt>, <tt>user_name</tt>)</span>
<span class='name'>API</span>
&mdash;
<div class='inline'><p>user name</p></div>
</li>
<li>
<span class='type'>(<tt><a href="String.html" title="String (class)">String</a></tt>, <tt>password</tt>)</span>
<span class='name'>API</span>
&mdash;
<div class='inline'><p>password</p></div>
</li>
<li>
<span class='type'>(<tt><a href="String.html" title="String (class)">String</a></tt>, <tt>user_name</tt>)</span>
<span class='name'>API</span>
&mdash;
<div class='inline'><p>URL (eg. http://localhost:3001/api)</p></div>
</li>
</ul>
<h3>Returns:</h3>
<ul class="return">
<li>
<span class='type'>(<tt><a href="DeltaCloud/API.html" title="DeltaCloud::API (class)">DeltaCloud::API</a></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/deltacloud.rb', line 32</span>
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='user_name identifier id'>user_name</span><span class='comma token'>,</span> <span class='password identifier id'>password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
<span class='API constant id'>API</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='user_name identifier id'>user_name</span><span class='comma token'>,</span> <span class='password identifier id'>password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Jul 30 12:16:31 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.6 (ruby-1.8.7).
</div>
</body>
</html>