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