foreman_api 0.1.8 → 0.1.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/doc/ForemanApi.html +3 -3
- data/doc/ForemanApi/Resources.html +4 -4
- data/doc/ForemanApi/Resources/Architecture.html +1 -1
- data/doc/ForemanApi/Resources/Audit.html +1 -1
- data/doc/ForemanApi/Resources/AuthSourceLdap.html +1 -1
- data/doc/ForemanApi/Resources/Autosign.html +330 -0
- data/doc/ForemanApi/Resources/Bookmark.html +1 -1
- data/doc/ForemanApi/Resources/CommonParameter.html +1 -1
- data/doc/ForemanApi/Resources/ComputeResource.html +1 -1
- data/doc/ForemanApi/Resources/ConfigTemplate.html +1 -1
- data/doc/ForemanApi/Resources/Dashboard.html +1 -1
- data/doc/ForemanApi/Resources/Domain.html +1 -1
- data/doc/ForemanApi/Resources/Environment.html +1 -1
- data/doc/ForemanApi/Resources/FactValue.html +1 -1
- data/doc/ForemanApi/Resources/Home.html +1 -1
- data/doc/ForemanApi/Resources/Host.html +38 -32
- data/doc/ForemanApi/Resources/HostClass.html +1 -1
- data/doc/ForemanApi/Resources/Hostgroup.html +1 -1
- data/doc/ForemanApi/Resources/HostgroupClass.html +1 -1
- data/doc/ForemanApi/Resources/Image.html +1 -1
- data/doc/ForemanApi/Resources/Interface.html +1 -1
- data/doc/ForemanApi/Resources/Location.html +1 -1
- data/doc/ForemanApi/Resources/LookupKey.html +1 -1
- data/doc/ForemanApi/Resources/Medium.html +5 -5
- data/doc/ForemanApi/Resources/Model.html +1 -1
- data/doc/ForemanApi/Resources/OperatingSystem.html +20 -16
- data/doc/ForemanApi/Resources/Organization.html +1 -1
- data/doc/ForemanApi/Resources/OverrideValue.html +1 -1
- data/doc/ForemanApi/Resources/Parameter.html +1 -1
- data/doc/ForemanApi/Resources/Plugin.html +330 -0
- data/doc/ForemanApi/Resources/Ptable.html +1 -1
- data/doc/ForemanApi/Resources/Puppetclass.html +1 -1
- data/doc/ForemanApi/Resources/Report.html +1 -1
- data/doc/ForemanApi/Resources/Role.html +1 -1
- data/doc/ForemanApi/Resources/Setting.html +1 -1
- data/doc/ForemanApi/Resources/SmartClassParameter.html +1 -1
- data/doc/ForemanApi/Resources/SmartProxy.html +1 -1
- data/doc/ForemanApi/Resources/SmartVariable.html +1 -1
- data/doc/ForemanApi/Resources/Statistic.html +1 -1
- data/doc/ForemanApi/Resources/Subnet.html +1 -1
- data/doc/ForemanApi/Resources/Task.html +354 -0
- data/doc/ForemanApi/Resources/TemplateCombination.html +1 -1
- data/doc/ForemanApi/Resources/TemplateKind.html +1 -1
- data/doc/ForemanApi/Resources/User.html +1 -1
- data/doc/ForemanApi/Resources/Usergroup.html +1 -1
- data/doc/_index.html +22 -1
- data/doc/class_list.html +1 -1
- data/doc/file.MIT-LICENSE.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +426 -390
- data/doc/top-level-namespace.html +1 -1
- data/lib/foreman_api/documentation.json +1 -1
- data/lib/foreman_api/resources/autosign.rb +18 -0
- data/lib/foreman_api/resources/host.rb +2 -0
- data/lib/foreman_api/resources/medium.rb +2 -2
- data/lib/foreman_api/resources/operating_system.rb +2 -0
- data/lib/foreman_api/resources/plugin.rb +18 -0
- data/lib/foreman_api/resources/task.rb +19 -0
- data/lib/foreman_api/version.rb +1 -1
- metadata +102 -101
- data/.gitignore +0 -3
- data/.yardopts +0 -4
- data/Gemfile +0 -11
- data/Rakefile +0 -1
- data/foreman_api.gemspec +0 -25
@@ -0,0 +1,330 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Class: ForemanApi::Resources::Plugin
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.7
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '../../';
|
20
|
+
framesUrl = "../../frames.html#!" + escape(window.location.href);
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="../../_index.html">Index (P)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../../ForemanApi.html" title="ForemanApi (module)">ForemanApi</a></span></span> » <span class='title'><span class='object_link'><a href="../Resources.html" title="ForemanApi::Resources (module)">Resources</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">Plugin</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
46
|
+
href="../../class_list.html">
|
47
|
+
Class List
|
48
|
+
</a>
|
49
|
+
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
51
|
+
href="../../method_list.html">
|
52
|
+
Method List
|
53
|
+
</a>
|
54
|
+
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
56
|
+
href="../../file_list.html">
|
57
|
+
File List
|
58
|
+
</a>
|
59
|
+
|
60
|
+
</div>
|
61
|
+
<div class="clear"></div>
|
62
|
+
</div>
|
63
|
+
|
64
|
+
<iframe id="search_frame"></iframe>
|
65
|
+
|
66
|
+
<div id="content"><h1>Class: ForemanApi::Resources::Plugin
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
<dt class="r1">Inherits:</dt>
|
75
|
+
<dd class="r1">
|
76
|
+
<span class="inheritName">Base</span>
|
77
|
+
|
78
|
+
<ul class="fullTree">
|
79
|
+
<li>Object</li>
|
80
|
+
|
81
|
+
<li class="next">Base</li>
|
82
|
+
|
83
|
+
<li class="next">ForemanApi::Resources::Plugin</li>
|
84
|
+
|
85
|
+
</ul>
|
86
|
+
<a href="#" class="inheritanceTree">show all</a>
|
87
|
+
|
88
|
+
</dd>
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
<dt class="r2 last">Defined in:</dt>
|
99
|
+
<dd class="r2 last">lib/foreman_api/resources/plugin.rb</dd>
|
100
|
+
|
101
|
+
</dl>
|
102
|
+
<div class="clear"></div>
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
|
112
|
+
<h2>
|
113
|
+
Class Method Summary
|
114
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
115
|
+
</h2>
|
116
|
+
|
117
|
+
<ul class="summary">
|
118
|
+
|
119
|
+
<li class="public ">
|
120
|
+
<span class="summary_signature">
|
121
|
+
|
122
|
+
<a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
</span>
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
137
|
+
|
138
|
+
</li>
|
139
|
+
|
140
|
+
|
141
|
+
</ul>
|
142
|
+
|
143
|
+
<h2>
|
144
|
+
Instance Method Summary
|
145
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
146
|
+
</h2>
|
147
|
+
|
148
|
+
<ul class="summary">
|
149
|
+
|
150
|
+
<li class="public ">
|
151
|
+
<span class="summary_signature">
|
152
|
+
|
153
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
</span>
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
<span class="summary_desc"><div class='inline'>
|
168
|
+
<p>First item: parsed data; second item: raw body.</p>
|
169
|
+
</div></span>
|
170
|
+
|
171
|
+
</li>
|
172
|
+
|
173
|
+
|
174
|
+
</ul>
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
<div id="class_method_details" class="method_details_list">
|
181
|
+
<h2>Class Method Details</h2>
|
182
|
+
|
183
|
+
|
184
|
+
<div class="method_details first">
|
185
|
+
<h3 class="signature first" id="doc-class_method">
|
186
|
+
|
187
|
+
+ (<tt>Object</tt>) <strong>doc</strong>
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
</h3><table class="source_code">
|
194
|
+
<tr>
|
195
|
+
<td>
|
196
|
+
<pre class="lines">
|
197
|
+
|
198
|
+
|
199
|
+
4
|
200
|
+
5
|
201
|
+
6</pre>
|
202
|
+
</td>
|
203
|
+
<td>
|
204
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/plugin.rb', line 4</span>
|
205
|
+
|
206
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
|
207
|
+
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>plugins</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
208
|
+
<span class='kw'>end</span></pre>
|
209
|
+
</td>
|
210
|
+
</tr>
|
211
|
+
</table>
|
212
|
+
</div>
|
213
|
+
|
214
|
+
</div>
|
215
|
+
|
216
|
+
<div id="instance_method_details" class="method_details_list">
|
217
|
+
<h2>Instance Method Details</h2>
|
218
|
+
|
219
|
+
|
220
|
+
<div class="method_details first">
|
221
|
+
<h3 class="signature first" id="index-instance_method">
|
222
|
+
|
223
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
</h3><div class="docstring">
|
230
|
+
<div class="discussion">
|
231
|
+
|
232
|
+
<p>Returns First item: parsed data; second item: raw body</p>
|
233
|
+
|
234
|
+
|
235
|
+
</div>
|
236
|
+
</div>
|
237
|
+
<div class="tags">
|
238
|
+
<p class="tag_title">Parameters:</p>
|
239
|
+
<ul class="param">
|
240
|
+
|
241
|
+
<li>
|
242
|
+
|
243
|
+
<span class='name'>params</span>
|
244
|
+
|
245
|
+
|
246
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
247
|
+
|
248
|
+
|
249
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
250
|
+
|
251
|
+
|
252
|
+
—
|
253
|
+
<div class='inline'>
|
254
|
+
<p>a hash of params to be passed to the service</p>
|
255
|
+
</div>
|
256
|
+
|
257
|
+
</li>
|
258
|
+
|
259
|
+
<li>
|
260
|
+
|
261
|
+
<span class='name'>headers</span>
|
262
|
+
|
263
|
+
|
264
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
265
|
+
|
266
|
+
|
267
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
268
|
+
|
269
|
+
|
270
|
+
—
|
271
|
+
<div class='inline'>
|
272
|
+
<p>additional http headers</p>
|
273
|
+
</div>
|
274
|
+
|
275
|
+
</li>
|
276
|
+
|
277
|
+
</ul>
|
278
|
+
|
279
|
+
<p class="tag_title">Returns:</p>
|
280
|
+
<ul class="return">
|
281
|
+
|
282
|
+
<li>
|
283
|
+
|
284
|
+
|
285
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
—
|
290
|
+
<div class='inline'>
|
291
|
+
<p>First item: parsed data; second item: raw body</p>
|
292
|
+
</div>
|
293
|
+
|
294
|
+
</li>
|
295
|
+
|
296
|
+
</ul>
|
297
|
+
|
298
|
+
</div><table class="source_code">
|
299
|
+
<tr>
|
300
|
+
<td>
|
301
|
+
<pre class="lines">
|
302
|
+
|
303
|
+
|
304
|
+
12
|
305
|
+
13
|
306
|
+
14</pre>
|
307
|
+
</td>
|
308
|
+
<td>
|
309
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/plugin.rb', line 12</span>
|
310
|
+
|
311
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
312
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
313
|
+
<span class='kw'>end</span></pre>
|
314
|
+
</td>
|
315
|
+
</tr>
|
316
|
+
</table>
|
317
|
+
</div>
|
318
|
+
|
319
|
+
</div>
|
320
|
+
|
321
|
+
</div>
|
322
|
+
|
323
|
+
<div id="footer">
|
324
|
+
Generated on Thu Dec 19 15:47:32 2013 by
|
325
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
326
|
+
0.8.7 (ruby-2.0.0).
|
327
|
+
</div>
|
328
|
+
|
329
|
+
</body>
|
330
|
+
</html>
|
@@ -987,7 +987,7 @@
|
|
987
987
|
</div>
|
988
988
|
|
989
989
|
<div id="footer">
|
990
|
-
Generated on Thu
|
990
|
+
Generated on Thu Dec 19 15:47:31 2013 by
|
991
991
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
992
992
|
0.8.7 (ruby-2.0.0).
|
993
993
|
</div>
|
@@ -1061,7 +1061,7 @@
|
|
1061
1061
|
</div>
|
1062
1062
|
|
1063
1063
|
<div id="footer">
|
1064
|
-
Generated on Thu
|
1064
|
+
Generated on Thu Dec 19 15:47:33 2013 by
|
1065
1065
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1066
1066
|
0.8.7 (ruby-2.0.0).
|
1067
1067
|
</div>
|
@@ -984,7 +984,7 @@
|
|
984
984
|
</div>
|
985
985
|
|
986
986
|
<div id="footer">
|
987
|
-
Generated on Thu
|
987
|
+
Generated on Thu Dec 19 15:47:32 2013 by
|
988
988
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
989
989
|
0.8.7 (ruby-2.0.0).
|
990
990
|
</div>
|
@@ -953,7 +953,7 @@
|
|
953
953
|
</div>
|
954
954
|
|
955
955
|
<div id="footer">
|
956
|
-
Generated on Thu
|
956
|
+
Generated on Thu Dec 19 15:47:30 2013 by
|
957
957
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
958
958
|
0.8.7 (ruby-2.0.0).
|
959
959
|
</div>
|
@@ -686,7 +686,7 @@
|
|
686
686
|
</div>
|
687
687
|
|
688
688
|
<div id="footer">
|
689
|
-
Generated on Thu
|
689
|
+
Generated on Thu Dec 19 15:47:32 2013 by
|
690
690
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
691
691
|
0.8.7 (ruby-2.0.0).
|
692
692
|
</div>
|
@@ -738,7 +738,7 @@
|
|
738
738
|
</div>
|
739
739
|
|
740
740
|
<div id="footer">
|
741
|
-
Generated on Thu
|
741
|
+
Generated on Thu Dec 19 15:47:34 2013 by
|
742
742
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
743
743
|
0.8.7 (ruby-2.0.0).
|
744
744
|
</div>
|
@@ -1283,7 +1283,7 @@
|
|
1283
1283
|
</div>
|
1284
1284
|
|
1285
1285
|
<div id="footer">
|
1286
|
-
Generated on Thu
|
1286
|
+
Generated on Thu Dec 19 15:47:33 2013 by
|
1287
1287
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1288
1288
|
0.8.7 (ruby-2.0.0).
|
1289
1289
|
</div>
|
@@ -1034,7 +1034,7 @@
|
|
1034
1034
|
</div>
|
1035
1035
|
|
1036
1036
|
<div id="footer">
|
1037
|
-
Generated on Thu
|
1037
|
+
Generated on Thu Dec 19 15:47:34 2013 by
|
1038
1038
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1039
1039
|
0.8.7 (ruby-2.0.0).
|
1040
1040
|
</div>
|
@@ -321,7 +321,7 @@
|
|
321
321
|
</div>
|
322
322
|
|
323
323
|
<div id="footer">
|
324
|
-
Generated on Thu
|
324
|
+
Generated on Thu Dec 19 15:47:32 2013 by
|
325
325
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
326
326
|
0.8.7 (ruby-2.0.0).
|
327
327
|
</div>
|
@@ -1035,7 +1035,7 @@
|
|
1035
1035
|
</div>
|
1036
1036
|
|
1037
1037
|
<div id="footer">
|
1038
|
-
Generated on Thu
|
1038
|
+
Generated on Thu Dec 19 15:47:31 2013 by
|
1039
1039
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1040
1040
|
0.8.7 (ruby-2.0.0).
|
1041
1041
|
</div>
|
@@ -0,0 +1,354 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Class: ForemanApi::Resources::Task
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.7
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '../../';
|
20
|
+
framesUrl = "../../frames.html#!" + escape(window.location.href);
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="../../_index.html">Index (T)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../../ForemanApi.html" title="ForemanApi (module)">ForemanApi</a></span></span> » <span class='title'><span class='object_link'><a href="../Resources.html" title="ForemanApi::Resources (module)">Resources</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">Task</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
46
|
+
href="../../class_list.html">
|
47
|
+
Class List
|
48
|
+
</a>
|
49
|
+
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
51
|
+
href="../../method_list.html">
|
52
|
+
Method List
|
53
|
+
</a>
|
54
|
+
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
56
|
+
href="../../file_list.html">
|
57
|
+
File List
|
58
|
+
</a>
|
59
|
+
|
60
|
+
</div>
|
61
|
+
<div class="clear"></div>
|
62
|
+
</div>
|
63
|
+
|
64
|
+
<iframe id="search_frame"></iframe>
|
65
|
+
|
66
|
+
<div id="content"><h1>Class: ForemanApi::Resources::Task
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
<dt class="r1">Inherits:</dt>
|
75
|
+
<dd class="r1">
|
76
|
+
<span class="inheritName">Base</span>
|
77
|
+
|
78
|
+
<ul class="fullTree">
|
79
|
+
<li>Object</li>
|
80
|
+
|
81
|
+
<li class="next">Base</li>
|
82
|
+
|
83
|
+
<li class="next">ForemanApi::Resources::Task</li>
|
84
|
+
|
85
|
+
</ul>
|
86
|
+
<a href="#" class="inheritanceTree">show all</a>
|
87
|
+
|
88
|
+
</dd>
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
<dt class="r2 last">Defined in:</dt>
|
99
|
+
<dd class="r2 last">lib/foreman_api/resources/task.rb</dd>
|
100
|
+
|
101
|
+
</dl>
|
102
|
+
<div class="clear"></div>
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
|
112
|
+
<h2>
|
113
|
+
Class Method Summary
|
114
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
115
|
+
</h2>
|
116
|
+
|
117
|
+
<ul class="summary">
|
118
|
+
|
119
|
+
<li class="public ">
|
120
|
+
<span class="summary_signature">
|
121
|
+
|
122
|
+
<a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
</span>
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
137
|
+
|
138
|
+
</li>
|
139
|
+
|
140
|
+
|
141
|
+
</ul>
|
142
|
+
|
143
|
+
<h2>
|
144
|
+
Instance Method Summary
|
145
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
146
|
+
</h2>
|
147
|
+
|
148
|
+
<ul class="summary">
|
149
|
+
|
150
|
+
<li class="public ">
|
151
|
+
<span class="summary_signature">
|
152
|
+
|
153
|
+
<a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
</span>
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
<span class="summary_desc"><div class='inline'>
|
168
|
+
<p>First item: parsed data; second item: raw body.</p>
|
169
|
+
</div></span>
|
170
|
+
|
171
|
+
</li>
|
172
|
+
|
173
|
+
|
174
|
+
</ul>
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
<div id="class_method_details" class="method_details_list">
|
181
|
+
<h2>Class Method Details</h2>
|
182
|
+
|
183
|
+
|
184
|
+
<div class="method_details first">
|
185
|
+
<h3 class="signature first" id="doc-class_method">
|
186
|
+
|
187
|
+
+ (<tt>Object</tt>) <strong>doc</strong>
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
</h3><table class="source_code">
|
194
|
+
<tr>
|
195
|
+
<td>
|
196
|
+
<pre class="lines">
|
197
|
+
|
198
|
+
|
199
|
+
4
|
200
|
+
5
|
201
|
+
6</pre>
|
202
|
+
</td>
|
203
|
+
<td>
|
204
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/task.rb', line 4</span>
|
205
|
+
|
206
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
|
207
|
+
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>tasks</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
208
|
+
<span class='kw'>end</span></pre>
|
209
|
+
</td>
|
210
|
+
</tr>
|
211
|
+
</table>
|
212
|
+
</div>
|
213
|
+
|
214
|
+
</div>
|
215
|
+
|
216
|
+
<div id="instance_method_details" class="method_details_list">
|
217
|
+
<h2>Instance Method Details</h2>
|
218
|
+
|
219
|
+
|
220
|
+
<div class="method_details first">
|
221
|
+
<h3 class="signature first" id="index-instance_method">
|
222
|
+
|
223
|
+
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
</h3><div class="docstring">
|
230
|
+
<div class="discussion">
|
231
|
+
|
232
|
+
<p>Returns First item: parsed data; second item: raw body</p>
|
233
|
+
|
234
|
+
|
235
|
+
</div>
|
236
|
+
</div>
|
237
|
+
<div class="tags">
|
238
|
+
<p class="tag_title">Parameters:</p>
|
239
|
+
<ul class="param">
|
240
|
+
|
241
|
+
<li>
|
242
|
+
|
243
|
+
<span class='name'>params</span>
|
244
|
+
|
245
|
+
|
246
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
247
|
+
|
248
|
+
|
249
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
250
|
+
|
251
|
+
|
252
|
+
—
|
253
|
+
<div class='inline'>
|
254
|
+
<p>a hash of params to be passed to the service</p>
|
255
|
+
</div>
|
256
|
+
|
257
|
+
</li>
|
258
|
+
|
259
|
+
<li>
|
260
|
+
|
261
|
+
<span class='name'>headers</span>
|
262
|
+
|
263
|
+
|
264
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
265
|
+
|
266
|
+
|
267
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
268
|
+
|
269
|
+
|
270
|
+
—
|
271
|
+
<div class='inline'>
|
272
|
+
<p>additional http headers</p>
|
273
|
+
</div>
|
274
|
+
|
275
|
+
</li>
|
276
|
+
|
277
|
+
</ul>
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
283
|
+
<ul class="option">
|
284
|
+
|
285
|
+
<li>
|
286
|
+
<span class="name">id</span>
|
287
|
+
<span class="type">(<tt>Object</tt>)</span>
|
288
|
+
<span class="default">
|
289
|
+
|
290
|
+
</span>
|
291
|
+
|
292
|
+
— <div class='inline'>
|
293
|
+
<p>Part of <tt>/api/orchestration/:id/tasks</tt> path</p>
|
294
|
+
</div>
|
295
|
+
|
296
|
+
</li>
|
297
|
+
|
298
|
+
</ul>
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
<p class="tag_title">Returns:</p>
|
304
|
+
<ul class="return">
|
305
|
+
|
306
|
+
<li>
|
307
|
+
|
308
|
+
|
309
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
—
|
314
|
+
<div class='inline'>
|
315
|
+
<p>First item: parsed data; second item: raw body</p>
|
316
|
+
</div>
|
317
|
+
|
318
|
+
</li>
|
319
|
+
|
320
|
+
</ul>
|
321
|
+
|
322
|
+
</div><table class="source_code">
|
323
|
+
<tr>
|
324
|
+
<td>
|
325
|
+
<pre class="lines">
|
326
|
+
|
327
|
+
|
328
|
+
13
|
329
|
+
14
|
330
|
+
15</pre>
|
331
|
+
</td>
|
332
|
+
<td>
|
333
|
+
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/task.rb', line 13</span>
|
334
|
+
|
335
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
336
|
+
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
337
|
+
<span class='kw'>end</span></pre>
|
338
|
+
</td>
|
339
|
+
</tr>
|
340
|
+
</table>
|
341
|
+
</div>
|
342
|
+
|
343
|
+
</div>
|
344
|
+
|
345
|
+
</div>
|
346
|
+
|
347
|
+
<div id="footer">
|
348
|
+
Generated on Thu Dec 19 15:47:31 2013 by
|
349
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
350
|
+
0.8.7 (ruby-2.0.0).
|
351
|
+
</div>
|
352
|
+
|
353
|
+
</body>
|
354
|
+
</html>
|