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