Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 37802c34263ea5a0f9352df19ef3830a1f3be42f / . / docs / epy / apiclient.discovery.ResourceMethodParameters-class.html
blob: 5814858be63d383fd29cae74f45a419e8cf87fb3 [file] [log] [blame]
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>apiclient.discovery.ResourceMethodParameters</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="apiclient-module.html">Package&nbsp;apiclient</a> ::
38 <a href="apiclient.discovery-module.html">Module&nbsp;discovery</a> ::
39 Class&nbsp;ResourceMethodParameters
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="apiclient.discovery.ResourceMethodParameters-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class ResourceMethodParameters</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.discovery-pysrc.html#ResourceMethodParameters">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame^]58<center> <map id="uml_class_diagram_for_apiclien_4" name="uml_class_diagram_for_apiclien_4">
59<area shape="rect" id="node3" href="apiclient.discovery.ResourceMethodParameters-class.html#__init__" title="Constructor for ResourceMethodParameters." alt="" coords="17,39,229,57"/>
60<area shape="rect" id="node3" href="apiclient.discovery.ResourceMethodParameters-class.html#set_parameters" title="Populates maps and lists based on method description." alt="" coords="17,57,229,76"/>
61<area shape="rect" id="node1" href="apiclient.discovery.ResourceMethodParameters-class.html" title="Represents the parameters associated with a method." alt="" coords="5,6,240,82"/>
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500[diff] [blame]62</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame^]63 <img src="uml_class_diagram_for_apiclien_4.gif" alt='' usemap="#uml_class_diagram_for_apiclien_4" ismap="ismap" class="graph-without-title" />
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500[diff] [blame]64</center>
65</center>
66<hr />
67<pre class="literalblock">
68Represents the parameters associated with a method.
69
70Attributes:
71 argmap: Map from method parameter name (string) to query parameter name
72 (string).
73 required_params: List of required parameters (represented by parameter
74 name as string).
75 repeated_params: List of repeated parameters (represented by parameter
76 name as string).
77 pattern_params: Map from method parameter name (string) to regular
78 expression (as a string). If the pattern is set for a parameter, the
79 value for that parameter must match the regular expression.
80 query_params: List of parameters (represented by parameter name as string)
81 that will be used in the query string.
82 path_params: Set of parameters (represented by parameter name as string)
83 that will be used in the base URL path.
84 param_types: Map from method parameter name (string) to parameter type. Type
85 can be any valid JSON schema type; valid values are 'any', 'array',
86 'boolean', 'integer', 'number', 'object', or 'string'. Reference:
87 http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
88 enum_params: Map from method parameter name (string) to list of strings,
89 where each list of strings is the list of acceptable enum values.
90
91</pre>
92
93<!-- ==================== INSTANCE METHODS ==================== -->
94<a name="section-InstanceMethods"></a>
95<table class="summary" border="1" cellpadding="3"
96 cellspacing="0" width="100%" bgcolor="white">
97<tr bgcolor="#70b0f0" class="table-header">
98 <td colspan="2" class="table-header">
99 <table border="0" cellpadding="0" cellspacing="0" width="100%">
100 <tr valign="top">
101 <td align="left"><span class="table-header">Instance Methods</span></td>
102 <td align="right" valign="top"
103 ><span class="options">[<a href="#section-InstanceMethods"
104 class="privatelink" onclick="toggle_private();"
105 >hide private</a>]</span></td>
106 </tr>
107 </table>
108 </td>
109</tr>
110<tr>
111 <td width="15%" align="right" valign="top" class="summary">
112 <span class="summary-type">&nbsp;</span>
113 </td><td class="summary">
114 <table width="100%" cellpadding="0" cellspacing="0" border="0">
115 <tr>
116 <td><span class="summary-sig"><a href="apiclient.discovery.ResourceMethodParameters-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
117 <span class="summary-sig-arg">method_desc</span>)</span><br />
118 Constructor for ResourceMethodParameters.</td>
119 <td align="right" valign="top">
120 <span class="codelink"><a href="apiclient.discovery-pysrc.html#ResourceMethodParameters.__init__">source&nbsp;code</a></span>
121
122 </td>
123 </tr>
124 </table>
125
126 </td>
127 </tr>
128<tr>
129 <td width="15%" align="right" valign="top" class="summary">
130 <span class="summary-type">&nbsp;</span>
131 </td><td class="summary">
132 <table width="100%" cellpadding="0" cellspacing="0" border="0">
133 <tr>
134 <td><span class="summary-sig"><a href="apiclient.discovery.ResourceMethodParameters-class.html#set_parameters" class="summary-sig-name">set_parameters</a>(<span class="summary-sig-arg">self</span>,
135 <span class="summary-sig-arg">method_desc</span>)</span><br />
136 Populates maps and lists based on method description.</td>
137 <td align="right" valign="top">
138 <span class="codelink"><a href="apiclient.discovery-pysrc.html#ResourceMethodParameters.set_parameters">source&nbsp;code</a></span>
139
140 </td>
141 </tr>
142 </table>
143
144 </td>
145 </tr>
146 <tr>
147 <td colspan="2" class="summary">
148 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
149 <code>__delattr__</code>,
150 <code>__format__</code>,
151 <code>__getattribute__</code>,
152 <code>__hash__</code>,
153 <code>__new__</code>,
154 <code>__reduce__</code>,
155 <code>__reduce_ex__</code>,
156 <code>__repr__</code>,
157 <code>__setattr__</code>,
158 <code>__sizeof__</code>,
159 <code>__str__</code>,
160 <code>__subclasshook__</code>
161 </p>
162 </td>
163 </tr>
164</table>
165<!-- ==================== PROPERTIES ==================== -->
166<a name="section-Properties"></a>
167<table class="summary" border="1" cellpadding="3"
168 cellspacing="0" width="100%" bgcolor="white">
169<tr bgcolor="#70b0f0" class="table-header">
170 <td colspan="2" class="table-header">
171 <table border="0" cellpadding="0" cellspacing="0" width="100%">
172 <tr valign="top">
173 <td align="left"><span class="table-header">Properties</span></td>
174 <td align="right" valign="top"
175 ><span class="options">[<a href="#section-Properties"
176 class="privatelink" onclick="toggle_private();"
177 >hide private</a>]</span></td>
178 </tr>
179 </table>
180 </td>
181</tr>
182 <tr>
183 <td colspan="2" class="summary">
184 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
185 <code>__class__</code>
186 </p>
187 </td>
188 </tr>
189</table>
190<!-- ==================== METHOD DETAILS ==================== -->
191<a name="section-MethodDetails"></a>
192<table class="details" border="1" cellpadding="3"
193 cellspacing="0" width="100%" bgcolor="white">
194<tr bgcolor="#70b0f0" class="table-header">
195 <td colspan="2" class="table-header">
196 <table border="0" cellpadding="0" cellspacing="0" width="100%">
197 <tr valign="top">
198 <td align="left"><span class="table-header">Method Details</span></td>
199 <td align="right" valign="top"
200 ><span class="options">[<a href="#section-MethodDetails"
201 class="privatelink" onclick="toggle_private();"
202 >hide private</a>]</span></td>
203 </tr>
204 </table>
205 </td>
206</tr>
207</table>
208<a name="__init__"></a>
209<div>
210<table class="details" border="1" cellpadding="3"
211 cellspacing="0" width="100%" bgcolor="white">
212<tr><td>
213 <table width="100%" cellpadding="0" cellspacing="0" border="0">
214 <tr valign="top"><td>
215 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
216 <span class="sig-arg">method_desc</span>)</span>
217 <br /><em class="fname">(Constructor)</em>
218 </h3>
219 </td><td align="right" valign="top"
220 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#ResourceMethodParameters.__init__">source&nbsp;code</a></span>&nbsp;
221 </td>
222 </tr></table>
223
224 <pre class="literalblock">
225Constructor for ResourceMethodParameters.
226
227Sets default values and defers to set_parameters to populate.
228
229Args:
230 method_desc: Dictionary with metadata describing an API method. Value
231 comes from the dictionary of methods stored in the 'methods' key in
232 the deserialized discovery document.
233
234</pre>
235 <dl class="fields">
236 <dt>Overrides:
237 object.__init__
238 </dt>
239 </dl>
240</td></tr></table>
241</div>
242<a name="set_parameters"></a>
243<div>
244<table class="details" border="1" cellpadding="3"
245 cellspacing="0" width="100%" bgcolor="white">
246<tr><td>
247 <table width="100%" cellpadding="0" cellspacing="0" border="0">
248 <tr valign="top"><td>
249 <h3 class="epydoc"><span class="sig"><span class="sig-name">set_parameters</span>(<span class="sig-arg">self</span>,
250 <span class="sig-arg">method_desc</span>)</span>
251 </h3>
252 </td><td align="right" valign="top"
253 ><span class="codelink"><a href="apiclient.discovery-pysrc.html#ResourceMethodParameters.set_parameters">source&nbsp;code</a></span>&nbsp;
254 </td>
255 </tr></table>
256
257 <pre class="literalblock">
258Populates maps and lists based on method description.
259
260Iterates through each parameter for the method and parses the values from
261the parameter dictionary.
262
263Args:
264 method_desc: Dictionary with metadata describing an API method. Value
265 comes from the dictionary of methods stored in the 'methods' key in
266 the deserialized discovery document.
267
268</pre>
269 <dl class="fields">
270 </dl>
271</td></tr></table>
272</div>
273<br />
274<!-- ==================== NAVIGATION BAR ==================== -->
275<table class="navbar" border="0" width="100%" cellpadding="0"
276 bgcolor="#a0c0ff" cellspacing="0">
277 <tr valign="middle">
278
279 <!-- Tree link -->
280 <th>&nbsp;&nbsp;&nbsp;<a
281 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
282
283 <!-- Index link -->
284 <th>&nbsp;&nbsp;&nbsp;<a
285 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
286
287 <!-- Help link -->
288 <th>&nbsp;&nbsp;&nbsp;<a
289 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
290
291 <th class="navbar" width="100%"></th>
292 </tr>
293</table>
294<table border="0" cellpadding="0" cellspacing="0" width="100%%">
295 <tr>
296 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame^]297 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:43 2013
Joe Gregoriob8006ce2013-03-07 10:33:19 -0500[diff] [blame]298 </td>
299 <td align="right" class="footer">
300 <a target="mainFrame" href="http://epydoc.sourceforge.net"
301 >http://epydoc.sourceforge.net</a>
302 </td>
303 </tr>
304</table>
305
306<script type="text/javascript">
307 <!--
308 // Private objects are initially displayed (because if
309 // javascript is turned off then we want them to be
310 // visible); but by default, we want to hide them. So hide
311 // them unless we have a cookie that says to show them.
312 checkCookie();
313 // -->
314</script>
315</body>
316</html>