| John Asmuth | 614db98 | 2014-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> <a |
| 19 | href="googleapiclient-module.html">Home</a> </th> |
| 20 | |
| 21 | <!-- Tree link --> |
| 22 | <th> <a |
| 23 | href="module-tree.html">Trees</a> </th> |
| 24 | |
| 25 | <!-- Index link --> |
| 26 | <th> <a |
| 27 | href="identifier-index.html">Indices</a> </th> |
| 28 | |
| 29 | <!-- Help link --> |
| 30 | <th> <a |
| 31 | href="help.html">Help</a> </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 googleapiclient</a> :: |
| 41 | <a href="googleapiclient.discovery-module.html">Module discovery</a> :: |
| 42 | Class 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 private</a>]</span></td></tr> |
| 50 | <tr><td align="right"><span class="options" |
| 51 | >[<a href="frames.html" target="_top">frames</a |
| 52 | >] | <a href="googleapiclient.discovery.ResourceMethodParameters-class.html" |
| 53 | target="_top">no 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 code</a></span></p> |
| 60 | <center> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 61 | |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 62 | </center> |
| 63 | <hr /> |
| 64 | <pre class="literalblock"> |
| 65 | Represents the parameters associated with a method. |
| 66 | |
| 67 | Attributes: |
| 68 | argmap: Map from method parameter name (string) to query parameter name |
| 69 | (string). |
| 70 | required_params: List of required parameters (represented by parameter |
| 71 | name as string). |
| 72 | repeated_params: List of repeated parameters (represented by parameter |
| 73 | name as string). |
| 74 | pattern_params: Map from method parameter name (string) to regular |
| 75 | expression (as a string). If the pattern is set for a parameter, the |
| 76 | value for that parameter must match the regular expression. |
| 77 | query_params: List of parameters (represented by parameter name as string) |
| 78 | that will be used in the query string. |
| 79 | path_params: Set of parameters (represented by parameter name as string) |
| 80 | that will be used in the base URL path. |
| 81 | param_types: Map from method parameter name (string) to parameter type. Type |
| 82 | can be any valid JSON schema type; valid values are 'any', 'array', |
| 83 | 'boolean', 'integer', 'number', 'object', or 'string'. Reference: |
| 84 | http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1 |
| 85 | enum_params: Map from method parameter name (string) to list of strings, |
| 86 | where each list of strings is the list of acceptable enum values. |
| 87 | |
| 88 | </pre> |
| 89 | |
| 90 | <!-- ==================== INSTANCE METHODS ==================== --> |
| 91 | <a name="section-InstanceMethods"></a> |
| 92 | <table class="summary" border="1" cellpadding="3" |
| 93 | cellspacing="0" width="100%" bgcolor="white"> |
| 94 | <tr bgcolor="#70b0f0" class="table-header"> |
| 95 | <td colspan="2" class="table-header"> |
| 96 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 97 | <tr valign="top"> |
| 98 | <td align="left"><span class="table-header">Instance Methods</span></td> |
| 99 | <td align="right" valign="top" |
| 100 | ><span class="options">[<a href="#section-InstanceMethods" |
| 101 | class="privatelink" onclick="toggle_private();" |
| 102 | >hide private</a>]</span></td> |
| 103 | </tr> |
| 104 | </table> |
| 105 | </td> |
| 106 | </tr> |
| 107 | <tr> |
| 108 | <td width="15%" align="right" valign="top" class="summary"> |
| 109 | <span class="summary-type"> </span> |
| 110 | </td><td class="summary"> |
| 111 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 112 | <tr> |
| 113 | <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>, |
| 114 | <span class="summary-sig-arg">method_desc</span>)</span><br /> |
| 115 | Constructor for ResourceMethodParameters.</td> |
| 116 | <td align="right" valign="top"> |
| 117 | <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#ResourceMethodParameters.__init__">source code</a></span> |
| 118 | |
| 119 | </td> |
| 120 | </tr> |
| 121 | </table> |
| 122 | |
| 123 | </td> |
| 124 | </tr> |
| 125 | <tr> |
| 126 | <td width="15%" align="right" valign="top" class="summary"> |
| 127 | <span class="summary-type"> </span> |
| 128 | </td><td class="summary"> |
| 129 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 130 | <tr> |
| 131 | <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>, |
| 132 | <span class="summary-sig-arg">method_desc</span>)</span><br /> |
| 133 | Populates maps and lists based on method description.</td> |
| 134 | <td align="right" valign="top"> |
| 135 | <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#ResourceMethodParameters.set_parameters">source code</a></span> |
| 136 | |
| 137 | </td> |
| 138 | </tr> |
| 139 | </table> |
| 140 | |
| 141 | </td> |
| 142 | </tr> |
| 143 | <tr> |
| 144 | <td colspan="2" class="summary"> |
| 145 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 146 | <code>__delattr__</code>, |
| 147 | <code>__format__</code>, |
| 148 | <code>__getattribute__</code>, |
| 149 | <code>__hash__</code>, |
| 150 | <code>__new__</code>, |
| 151 | <code>__reduce__</code>, |
| 152 | <code>__reduce_ex__</code>, |
| 153 | <code>__repr__</code>, |
| 154 | <code>__setattr__</code>, |
| 155 | <code>__sizeof__</code>, |
| 156 | <code>__str__</code>, |
| 157 | <code>__subclasshook__</code> |
| 158 | </p> |
| 159 | </td> |
| 160 | </tr> |
| 161 | </table> |
| 162 | <!-- ==================== PROPERTIES ==================== --> |
| 163 | <a name="section-Properties"></a> |
| 164 | <table class="summary" border="1" cellpadding="3" |
| 165 | cellspacing="0" width="100%" bgcolor="white"> |
| 166 | <tr bgcolor="#70b0f0" class="table-header"> |
| 167 | <td colspan="2" class="table-header"> |
| 168 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 169 | <tr valign="top"> |
| 170 | <td align="left"><span class="table-header">Properties</span></td> |
| 171 | <td align="right" valign="top" |
| 172 | ><span class="options">[<a href="#section-Properties" |
| 173 | class="privatelink" onclick="toggle_private();" |
| 174 | >hide private</a>]</span></td> |
| 175 | </tr> |
| 176 | </table> |
| 177 | </td> |
| 178 | </tr> |
| 179 | <tr> |
| 180 | <td colspan="2" class="summary"> |
| 181 | <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
| 182 | <code>__class__</code> |
| 183 | </p> |
| 184 | </td> |
| 185 | </tr> |
| 186 | </table> |
| 187 | <!-- ==================== METHOD DETAILS ==================== --> |
| 188 | <a name="section-MethodDetails"></a> |
| 189 | <table class="details" border="1" cellpadding="3" |
| 190 | cellspacing="0" width="100%" bgcolor="white"> |
| 191 | <tr bgcolor="#70b0f0" class="table-header"> |
| 192 | <td colspan="2" class="table-header"> |
| 193 | <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 194 | <tr valign="top"> |
| 195 | <td align="left"><span class="table-header">Method Details</span></td> |
| 196 | <td align="right" valign="top" |
| 197 | ><span class="options">[<a href="#section-MethodDetails" |
| 198 | class="privatelink" onclick="toggle_private();" |
| 199 | >hide private</a>]</span></td> |
| 200 | </tr> |
| 201 | </table> |
| 202 | </td> |
| 203 | </tr> |
| 204 | </table> |
| 205 | <a name="__init__"></a> |
| 206 | <div> |
| 207 | <table class="details" border="1" cellpadding="3" |
| 208 | cellspacing="0" width="100%" bgcolor="white"> |
| 209 | <tr><td> |
| 210 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 211 | <tr valign="top"><td> |
| 212 | <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
| 213 | <span class="sig-arg">method_desc</span>)</span> |
| 214 | <br /><em class="fname">(Constructor)</em> |
| 215 | </h3> |
| 216 | </td><td align="right" valign="top" |
| 217 | ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#ResourceMethodParameters.__init__">source code</a></span> |
| 218 | </td> |
| 219 | </tr></table> |
| 220 | |
| 221 | <pre class="literalblock"> |
| 222 | Constructor for ResourceMethodParameters. |
| 223 | |
| 224 | Sets default values and defers to set_parameters to populate. |
| 225 | |
| 226 | Args: |
| 227 | method_desc: Dictionary with metadata describing an API method. Value |
| 228 | comes from the dictionary of methods stored in the 'methods' key in |
| 229 | the deserialized discovery document. |
| 230 | |
| 231 | </pre> |
| 232 | <dl class="fields"> |
| 233 | <dt>Overrides: |
| 234 | object.__init__ |
| 235 | </dt> |
| 236 | </dl> |
| 237 | </td></tr></table> |
| 238 | </div> |
| 239 | <a name="set_parameters"></a> |
| 240 | <div> |
| 241 | <table class="details" border="1" cellpadding="3" |
| 242 | cellspacing="0" width="100%" bgcolor="white"> |
| 243 | <tr><td> |
| 244 | <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 245 | <tr valign="top"><td> |
| 246 | <h3 class="epydoc"><span class="sig"><span class="sig-name">set_parameters</span>(<span class="sig-arg">self</span>, |
| 247 | <span class="sig-arg">method_desc</span>)</span> |
| 248 | </h3> |
| 249 | </td><td align="right" valign="top" |
| 250 | ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#ResourceMethodParameters.set_parameters">source code</a></span> |
| 251 | </td> |
| 252 | </tr></table> |
| 253 | |
| 254 | <pre class="literalblock"> |
| 255 | Populates maps and lists based on method description. |
| 256 | |
| 257 | Iterates through each parameter for the method and parses the values from |
| 258 | the parameter dictionary. |
| 259 | |
| 260 | Args: |
| 261 | method_desc: Dictionary with metadata describing an API method. Value |
| 262 | comes from the dictionary of methods stored in the 'methods' key in |
| 263 | the deserialized discovery document. |
| 264 | |
| 265 | </pre> |
| 266 | <dl class="fields"> |
| 267 | </dl> |
| 268 | </td></tr></table> |
| 269 | </div> |
| 270 | <br /> |
| 271 | <!-- ==================== NAVIGATION BAR ==================== --> |
| 272 | <table class="navbar" border="0" width="100%" cellpadding="0" |
| 273 | bgcolor="#a0c0ff" cellspacing="0"> |
| 274 | <tr valign="middle"> |
| 275 | <!-- Home link --> |
| 276 | <th> <a |
| 277 | href="googleapiclient-module.html">Home</a> </th> |
| 278 | |
| 279 | <!-- Tree link --> |
| 280 | <th> <a |
| 281 | href="module-tree.html">Trees</a> </th> |
| 282 | |
| 283 | <!-- Index link --> |
| 284 | <th> <a |
| 285 | href="identifier-index.html">Indices</a> </th> |
| 286 | |
| 287 | <!-- Help link --> |
| 288 | <th> <a |
| 289 | href="help.html">Help</a> </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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 297 | Generated by Epydoc 3.0.1 on Thu Apr 30 17:06:05 2020 |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [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> |