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.model</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 Module model 42 </span> 43 </td> 44 <td> 45 <table cellpadding="0" cellspacing="0"> 46 <!-- hide/show private --> 47 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" 48 onclick="toggle_private();">hide private</a>]</span></td></tr> 49 <tr><td align="right"><span class="options" 50 >[<a href="frames.html" target="_top">frames</a 51 >] | <a href="googleapiclient.model-module.html" 52 target="_top">no frames</a>]</span></td></tr> 53 </table> 54 </td> 55 </tr> 56</table> 57<!-- ==================== MODULE DESCRIPTION ==================== --> 58<h1 class="epydoc">Module model</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.model-pysrc.html">source code</a></span></p> 59<p>Model objects for requests and responses.</p> 60 <p>Each API may support one or more serializations, such as JSON, Atom, 61 etc. The model classes are responsible for converting between the wire 62 format and the Python object representation.</p> 63 64<hr /> 65<div class="fields"> <p><strong>Author:</strong> 66 [email protected] (Joe Gregorio) 67 </p> 68</div><!-- ==================== CLASSES ==================== --> 69<a name="section-Classes"></a> 70<table class="summary" border="1" cellpadding="3" 71 cellspacing="0" width="100%" bgcolor="white"> 72<tr bgcolor="#70b0f0" class="table-header"> 73 <td colspan="2" class="table-header"> 74 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 75 <tr valign="top"> 76 <td align="left"><span class="table-header">Classes</span></td> 77 <td align="right" valign="top" 78 ><span class="options">[<a href="#section-Classes" 79 class="privatelink" onclick="toggle_private();" 80 >hide private</a>]</span></td> 81 </tr> 82 </table> 83 </td> 84</tr> 85<tr> 86 <td width="15%" align="right" valign="top" class="summary"> 87 <span class="summary-type"> </span> 88 </td><td class="summary"> 89 <a href="googleapiclient.model.Model-class.html" class="summary-name">Model</a><br /> 90 Model base class. 91 </td> 92 </tr> 93<tr> 94 <td width="15%" align="right" valign="top" class="summary"> 95 <span class="summary-type"> </span> 96 </td><td class="summary"> 97 <a href="googleapiclient.model.BaseModel-class.html" class="summary-name">BaseModel</a><br /> 98 Base model class. 99 </td> 100 </tr> 101<tr> 102 <td width="15%" align="right" valign="top" class="summary"> 103 <span class="summary-type"> </span> 104 </td><td class="summary"> 105 <a href="googleapiclient.model.JsonModel-class.html" class="summary-name">JsonModel</a><br /> 106 Model class for JSON. 107 </td> 108 </tr> 109<tr> 110 <td width="15%" align="right" valign="top" class="summary"> 111 <span class="summary-type"> </span> 112 </td><td class="summary"> 113 <a href="googleapiclient.model.RawModel-class.html" class="summary-name">RawModel</a><br /> 114 Model class for requests that don't return JSON. 115 </td> 116 </tr> 117<tr> 118 <td width="15%" align="right" valign="top" class="summary"> 119 <span class="summary-type"> </span> 120 </td><td class="summary"> 121 <a href="googleapiclient.model.MediaModel-class.html" class="summary-name">MediaModel</a><br /> 122 Model class for requests that return Media. 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 <a href="googleapiclient.model.ProtocolBufferModel-class.html" class="summary-name">ProtocolBufferModel</a><br /> 130 Model class for protocol buffers. 131 </td> 132 </tr> 133</table> 134<!-- ==================== FUNCTIONS ==================== --> 135<a name="section-Functions"></a> 136<table class="summary" border="1" cellpadding="3" 137 cellspacing="0" width="100%" bgcolor="white"> 138<tr bgcolor="#70b0f0" class="table-header"> 139 <td colspan="2" class="table-header"> 140 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 141 <tr valign="top"> 142 <td align="left"><span class="table-header">Functions</span></td> 143 <td align="right" valign="top" 144 ><span class="options">[<a href="#section-Functions" 145 class="privatelink" onclick="toggle_private();" 146 >hide private</a>]</span></td> 147 </tr> 148 </table> 149 </td> 150</tr> 151<tr class="private"> 152 <td width="15%" align="right" valign="top" class="summary"> 153 <span class="summary-type"> </span> 154 </td><td class="summary"> 155 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 156 <tr> 157 <td><span class="summary-sig"><a name="_abstract"></a><span class="summary-sig-name">_abstract</span>()</span></td> 158 <td align="right" valign="top"> 159 <span class="codelink"><a href="googleapiclient.model-pysrc.html#_abstract">source code</a></span> 160 161 </td> 162 </tr> 163 </table> 164 165 </td> 166 </tr> 167<tr> 168 <td width="15%" align="right" valign="top" class="summary"> 169 <span class="summary-type"> </span> 170 </td><td class="summary"> 171 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 172 <tr> 173 <td><span class="summary-sig"><a href="googleapiclient.model-module.html#makepatch" class="summary-sig-name">makepatch</a>(<span class="summary-sig-arg">original</span>, 174 <span class="summary-sig-arg">modified</span>)</span><br /> 175 Create a patch object.</td> 176 <td align="right" valign="top"> 177 <span class="codelink"><a href="googleapiclient.model-pysrc.html#makepatch">source code</a></span> 178 179 </td> 180 </tr> 181 </table> 182 183 </td> 184 </tr> 185</table> 186<!-- ==================== VARIABLES ==================== --> 187<a name="section-Variables"></a> 188<table class="summary" border="1" cellpadding="3" 189 cellspacing="0" width="100%" bgcolor="white"> 190<tr bgcolor="#70b0f0" class="table-header"> 191 <td colspan="2" class="table-header"> 192 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 193 <tr valign="top"> 194 <td align="left"><span class="table-header">Variables</span></td> 195 <td align="right" valign="top" 196 ><span class="options">[<a href="#section-Variables" 197 class="privatelink" onclick="toggle_private();" 198 >hide private</a>]</span></td> 199 </tr> 200 </table> 201 </td> 202</tr> 203<tr class="private"> 204 <td width="15%" align="right" valign="top" class="summary"> 205 <span class="summary-type"> </span> 206 </td><td class="summary"> 207 <a name="_LIBRARY_VERSION"></a><span class="summary-name">_LIBRARY_VERSION</span> = <code title="'1.10.0'"><code class="variable-quote">'</code><code class="variable-string">1.10.0</code><code class="variable-quote">'</code></code> 208 </td> 209 </tr> 210<tr class="private"> 211 <td width="15%" align="right" valign="top" class="summary"> 212 <span class="summary-type"> </span> 213 </td><td class="summary"> 214 <a name="_PY_VERSION"></a><span class="summary-name">_PY_VERSION</span> = <code title="'2.7.18'"><code class="variable-quote">'</code><code class="variable-string">2.7.18</code><code class="variable-quote">'</code></code> 215 </td> 216 </tr> 217<tr> 218 <td width="15%" align="right" valign="top" class="summary"> 219 <span class="summary-type"> </span> 220 </td><td class="summary"> 221 <a name="LOGGER"></a><span class="summary-name">LOGGER</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code> 222 </td> 223 </tr> 224<tr> 225 <td width="15%" align="right" valign="top" class="summary"> 226 <span class="summary-type"> </span> 227 </td><td class="summary"> 228 <a name="dump_request_response"></a><span class="summary-name">dump_request_response</span> = <code title="False">False</code> 229 </td> 230 </tr> 231<tr> 232 <td width="15%" align="right" valign="top" class="summary"> 233 <span class="summary-type"> </span> 234 </td><td class="summary"> 235 <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code> 236 </td> 237 </tr> 238</table> 239<!-- ==================== FUNCTION DETAILS ==================== --> 240<a name="section-FunctionDetails"></a> 241<table class="details" border="1" cellpadding="3" 242 cellspacing="0" width="100%" bgcolor="white"> 243<tr bgcolor="#70b0f0" class="table-header"> 244 <td colspan="2" class="table-header"> 245 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 246 <tr valign="top"> 247 <td align="left"><span class="table-header">Function Details</span></td> 248 <td align="right" valign="top" 249 ><span class="options">[<a href="#section-FunctionDetails" 250 class="privatelink" onclick="toggle_private();" 251 >hide private</a>]</span></td> 252 </tr> 253 </table> 254 </td> 255</tr> 256</table> 257<a name="makepatch"></a> 258<div> 259<table class="details" border="1" cellpadding="3" 260 cellspacing="0" width="100%" bgcolor="white"> 261<tr><td> 262 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 263 <tr valign="top"><td> 264 <h3 class="epydoc"><span class="sig"><span class="sig-name">makepatch</span>(<span class="sig-arg">original</span>, 265 <span class="sig-arg">modified</span>)</span> 266 </h3> 267 </td><td align="right" valign="top" 268 ><span class="codelink"><a href="googleapiclient.model-pysrc.html#makepatch">source code</a></span> 269 </td> 270 </tr></table> 271 272 <pre class="literalblock"> 273Create a patch object. 274 275Some methods support PATCH, an efficient way to send updates to a resource. 276This method allows the easy construction of patch bodies by looking at the 277differences between a resource before and after it was modified. 278 279Args: 280 original: object, the original deserialized resource 281 modified: object, the modified deserialized resource 282Returns: 283 An object that contains only the changes from original to modified, in a 284 form suitable to pass to a PATCH method. 285 286Example usage: 287 item = service.activities().get(postid=postid, userid=userid).execute() 288 original = copy.deepcopy(item) 289 item['object']['content'] = 'This is updated.' 290 service.activities.patch(postid=postid, userid=userid, 291 body=makepatch(original, item)).execute() 292 293</pre> 294 <dl class="fields"> 295 </dl> 296</td></tr></table> 297</div> 298<br /> 299<!-- ==================== NAVIGATION BAR ==================== --> 300<table class="navbar" border="0" width="100%" cellpadding="0" 301 bgcolor="#a0c0ff" cellspacing="0"> 302 <tr valign="middle"> 303 <!-- Home link --> 304 <th> <a 305 href="googleapiclient-module.html">Home</a> </th> 306 307 <!-- Tree link --> 308 <th> <a 309 href="module-tree.html">Trees</a> </th> 310 311 <!-- Index link --> 312 <th> <a 313 href="identifier-index.html">Indices</a> </th> 314 315 <!-- Help link --> 316 <th> <a 317 href="help.html">Help</a> </th> 318 319 <th class="navbar" width="100%"></th> 320 </tr> 321</table> 322<table border="0" cellpadding="0" cellspacing="0" width="100%%"> 323 <tr> 324 <td align="left" class="footer"> 325 Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 326 </td> 327 <td align="right" class="footer"> 328 <a target="mainFrame" href="http://epydoc.sourceforge.net" 329 >http://epydoc.sourceforge.net</a> 330 </td> 331 </tr> 332</table> 333 334<script type="text/javascript"> 335 <!-- 336 // Private objects are initially displayed (because if 337 // javascript is turned off then we want them to be 338 // visible); but by default, we want to hide them. So hide 339 // them unless we have a cookie that says to show them. 340 checkCookie(); 341 // --> 342</script> 343</body> 344</html> 345