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