Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ee90896d7183072d29fc60d0b8540360609ffa2c / . / docs / epy / apiclient.model-module.html
blob: 12e6a7541d16213f7f7eab6466872679485c846d [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -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>apiclient.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
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 Module&nbsp;model
39 </span>
40 </td>
41 <td>
42 <table cellpadding="0" cellspacing="0">
43 <!-- hide/show private -->
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
45 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="apiclient.model-module.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<!-- ==================== MODULE DESCRIPTION ==================== -->
55<h1 class="epydoc">Module model</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.model-pysrc.html">source&nbsp;code</a></span></p>
56<pre class="literalblock">
57Model objects for requests and responses.
58
59Each API may support one or more serializations, such
60as JSON, Atom, etc. The model classes are responsible
61for converting between the wire format and the Python
62object representation.
63
64</pre>
65
66<hr />
67<div class="fields"> <p><strong>Author:</strong>
68 jcgregorio@google.com (Joe Gregorio)
69 </p>
70</div><!-- ==================== CLASSES ==================== -->
71<a name="section-Classes"></a>
72<table class="summary" border="1" cellpadding="3"
73 cellspacing="0" width="100%" bgcolor="white">
74<tr bgcolor="#70b0f0" class="table-header">
75 <td colspan="2" class="table-header">
76 <table border="0" cellpadding="0" cellspacing="0" width="100%">
77 <tr valign="top">
78 <td align="left"><span class="table-header">Classes</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-Classes"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86</tr>
87<tr>
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 <a href="apiclient.model.Model-class.html" class="summary-name">Model</a><br />
92 Model base class.
93 </td>
94 </tr>
95<tr>
96 <td width="15%" align="right" valign="top" class="summary">
97 <span class="summary-type">&nbsp;</span>
98 </td><td class="summary">
99 <a href="apiclient.model.BaseModel-class.html" class="summary-name">BaseModel</a><br />
100 Base model class.
101 </td>
102 </tr>
103<tr>
104 <td width="15%" align="right" valign="top" class="summary">
105 <span class="summary-type">&nbsp;</span>
106 </td><td class="summary">
107 <a href="apiclient.model.JsonModel-class.html" class="summary-name">JsonModel</a><br />
108 Model class for JSON.
109 </td>
110 </tr>
111<tr>
112 <td width="15%" align="right" valign="top" class="summary">
113 <span class="summary-type">&nbsp;</span>
114 </td><td class="summary">
115 <a href="apiclient.model.RawModel-class.html" class="summary-name">RawModel</a><br />
116 Model class for requests that don't return JSON.
117 </td>
118 </tr>
119<tr>
120 <td width="15%" align="right" valign="top" class="summary">
121 <span class="summary-type">&nbsp;</span>
122 </td><td class="summary">
Joe Gregorioebd0b842012-06-15 14:14:17 -0400[diff] [blame]123 <a href="apiclient.model.MediaModel-class.html" class="summary-name">MediaModel</a><br />
124 Model class for requests that return Media.
125 </td>
126 </tr>
127<tr>
128 <td width="15%" align="right" valign="top" class="summary">
129 <span class="summary-type">&nbsp;</span>
130 </td><td class="summary">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]131 <a href="apiclient.model.ProtocolBufferModel-class.html" class="summary-name">ProtocolBufferModel</a><br />
132 Model class for protocol buffers.
133 </td>
134 </tr>
135</table>
136<!-- ==================== FUNCTIONS ==================== -->
137<a name="section-Functions"></a>
138<table class="summary" border="1" cellpadding="3"
139 cellspacing="0" width="100%" bgcolor="white">
140<tr bgcolor="#70b0f0" class="table-header">
141 <td colspan="2" class="table-header">
142 <table border="0" cellpadding="0" cellspacing="0" width="100%">
143 <tr valign="top">
144 <td align="left"><span class="table-header">Functions</span></td>
145 <td align="right" valign="top"
146 ><span class="options">[<a href="#section-Functions"
147 class="privatelink" onclick="toggle_private();"
148 >hide private</a>]</span></td>
149 </tr>
150 </table>
151 </td>
152</tr>
153<tr class="private">
154 <td width="15%" align="right" valign="top" class="summary">
155 <span class="summary-type">&nbsp;</span>
156 </td><td class="summary">
157 <table width="100%" cellpadding="0" cellspacing="0" border="0">
158 <tr>
159 <td><span class="summary-sig"><a name="_abstract"></a><span class="summary-sig-name">_abstract</span>()</span></td>
160 <td align="right" valign="top">
161 <span class="codelink"><a href="apiclient.model-pysrc.html#_abstract">source&nbsp;code</a></span>
162
163 </td>
164 </tr>
165 </table>
166
167 </td>
168 </tr>
169<tr>
170 <td width="15%" align="right" valign="top" class="summary">
171 <span class="summary-type">&nbsp;</span>
172 </td><td class="summary">
173 <table width="100%" cellpadding="0" cellspacing="0" border="0">
174 <tr>
175 <td><span class="summary-sig"><a href="apiclient.model-module.html#makepatch" class="summary-sig-name">makepatch</a>(<span class="summary-sig-arg">original</span>,
176 <span class="summary-sig-arg">modified</span>)</span><br />
177 Create a patch object.</td>
178 <td align="right" valign="top">
179 <span class="codelink"><a href="apiclient.model-pysrc.html#makepatch">source&nbsp;code</a></span>
180
181 </td>
182 </tr>
183 </table>
184
185 </td>
186 </tr>
187</table>
188<!-- ==================== VARIABLES ==================== -->
189<a name="section-Variables"></a>
190<table class="summary" 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">Variables</span></td>
197 <td align="right" valign="top"
198 ><span class="options">[<a href="#section-Variables"
199 class="privatelink" onclick="toggle_private();"
200 >hide private</a>]</span></td>
201 </tr>
202 </table>
203 </td>
204</tr>
205<tr>
206 <td width="15%" align="right" valign="top" class="summary">
207 <span class="summary-type">&nbsp;</span>
208 </td><td class="summary">
209 <a name="FLAGS"></a><span class="summary-name">FLAGS</span> = <code title="gflags.FLAGS">gflags.FLAGS</code>
210 </td>
211 </tr>
212<tr>
213 <td width="15%" align="right" valign="top" class="summary">
214 <span class="summary-type">&nbsp;</span>
215 </td><td class="summary">
216 <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'apiclient'"><code class="variable-quote">'</code><code class="variable-string">apiclient</code><code class="variable-quote">'</code></code>
217 </td>
218 </tr>
219</table>
220<!-- ==================== FUNCTION DETAILS ==================== -->
221<a name="section-FunctionDetails"></a>
222<table class="details" border="1" cellpadding="3"
223 cellspacing="0" width="100%" bgcolor="white">
224<tr bgcolor="#70b0f0" class="table-header">
225 <td colspan="2" class="table-header">
226 <table border="0" cellpadding="0" cellspacing="0" width="100%">
227 <tr valign="top">
228 <td align="left"><span class="table-header">Function Details</span></td>
229 <td align="right" valign="top"
230 ><span class="options">[<a href="#section-FunctionDetails"
231 class="privatelink" onclick="toggle_private();"
232 >hide private</a>]</span></td>
233 </tr>
234 </table>
235 </td>
236</tr>
237</table>
238<a name="makepatch"></a>
239<div>
240<table class="details" border="1" cellpadding="3"
241 cellspacing="0" width="100%" bgcolor="white">
242<tr><td>
243 <table width="100%" cellpadding="0" cellspacing="0" border="0">
244 <tr valign="top"><td>
245 <h3 class="epydoc"><span class="sig"><span class="sig-name">makepatch</span>(<span class="sig-arg">original</span>,
246 <span class="sig-arg">modified</span>)</span>
247 </h3>
248 </td><td align="right" valign="top"
249 ><span class="codelink"><a href="apiclient.model-pysrc.html#makepatch">source&nbsp;code</a></span>&nbsp;
250 </td>
251 </tr></table>
252
253 <pre class="literalblock">
254Create a patch object.
255
256Some methods support PATCH, an efficient way to send updates to a resource.
257This method allows the easy construction of patch bodies by looking at the
258differences between a resource before and after it was modified.
259
260Args:
261 original: object, the original deserialized resource
262 modified: object, the modified deserialized resource
263Returns:
264 An object that contains only the changes from original to modified, in a
265 form suitable to pass to a PATCH method.
266
267Example usage:
268 item = service.activities().get(postid=postid, userid=userid).execute()
269 original = copy.deepcopy(item)
270 item['object']['content'] = 'This is updated.'
271 service.activities.patch(postid=postid, userid=userid,
272 body=makepatch(original, item)).execute()
273
274</pre>
275 <dl class="fields">
276 </dl>
277</td></tr></table>
278</div>
279<br />
280<!-- ==================== NAVIGATION BAR ==================== -->
281<table class="navbar" border="0" width="100%" cellpadding="0"
282 bgcolor="#a0c0ff" cellspacing="0">
283 <tr valign="middle">
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">
Joe Gregorio0cd347a2012-08-30 08:22:27 -0400[diff] [blame]303 Generated by Epydoc 3.0.1 on Thu Aug 30 07:12:42 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]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>