Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / apiclient.model-module.html
blob: df6e3d4e6ab2496813fb90c18deba78cd5ae492b [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">
123 <a href="apiclient.model.ProtocolBufferModel-class.html" class="summary-name">ProtocolBufferModel</a><br />
124 Model class for protocol buffers.
125 </td>
126 </tr>
127</table>
128<!-- ==================== FUNCTIONS ==================== -->
129<a name="section-Functions"></a>
130<table class="summary" border="1" cellpadding="3"
131 cellspacing="0" width="100%" bgcolor="white">
132<tr bgcolor="#70b0f0" class="table-header">
133 <td colspan="2" class="table-header">
134 <table border="0" cellpadding="0" cellspacing="0" width="100%">
135 <tr valign="top">
136 <td align="left"><span class="table-header">Functions</span></td>
137 <td align="right" valign="top"
138 ><span class="options">[<a href="#section-Functions"
139 class="privatelink" onclick="toggle_private();"
140 >hide private</a>]</span></td>
141 </tr>
142 </table>
143 </td>
144</tr>
145<tr class="private">
146 <td width="15%" align="right" valign="top" class="summary">
147 <span class="summary-type">&nbsp;</span>
148 </td><td class="summary">
149 <table width="100%" cellpadding="0" cellspacing="0" border="0">
150 <tr>
151 <td><span class="summary-sig"><a name="_abstract"></a><span class="summary-sig-name">_abstract</span>()</span></td>
152 <td align="right" valign="top">
153 <span class="codelink"><a href="apiclient.model-pysrc.html#_abstract">source&nbsp;code</a></span>
154
155 </td>
156 </tr>
157 </table>
158
159 </td>
160 </tr>
161<tr>
162 <td width="15%" align="right" valign="top" class="summary">
163 <span class="summary-type">&nbsp;</span>
164 </td><td class="summary">
165 <table width="100%" cellpadding="0" cellspacing="0" border="0">
166 <tr>
167 <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>,
168 <span class="summary-sig-arg">modified</span>)</span><br />
169 Create a patch object.</td>
170 <td align="right" valign="top">
171 <span class="codelink"><a href="apiclient.model-pysrc.html#makepatch">source&nbsp;code</a></span>
172
173 </td>
174 </tr>
175 </table>
176
177 </td>
178 </tr>
179</table>
180<!-- ==================== VARIABLES ==================== -->
181<a name="section-Variables"></a>
182<table class="summary" border="1" cellpadding="3"
183 cellspacing="0" width="100%" bgcolor="white">
184<tr bgcolor="#70b0f0" class="table-header">
185 <td colspan="2" class="table-header">
186 <table border="0" cellpadding="0" cellspacing="0" width="100%">
187 <tr valign="top">
188 <td align="left"><span class="table-header">Variables</span></td>
189 <td align="right" valign="top"
190 ><span class="options">[<a href="#section-Variables"
191 class="privatelink" onclick="toggle_private();"
192 >hide private</a>]</span></td>
193 </tr>
194 </table>
195 </td>
196</tr>
197<tr>
198 <td width="15%" align="right" valign="top" class="summary">
199 <span class="summary-type">&nbsp;</span>
200 </td><td class="summary">
201 <a name="FLAGS"></a><span class="summary-name">FLAGS</span> = <code title="gflags.FLAGS">gflags.FLAGS</code>
202 </td>
203 </tr>
204<tr>
205 <td width="15%" align="right" valign="top" class="summary">
206 <span class="summary-type">&nbsp;</span>
207 </td><td class="summary">
208 <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>
209 </td>
210 </tr>
211</table>
212<!-- ==================== FUNCTION DETAILS ==================== -->
213<a name="section-FunctionDetails"></a>
214<table class="details" border="1" cellpadding="3"
215 cellspacing="0" width="100%" bgcolor="white">
216<tr bgcolor="#70b0f0" class="table-header">
217 <td colspan="2" class="table-header">
218 <table border="0" cellpadding="0" cellspacing="0" width="100%">
219 <tr valign="top">
220 <td align="left"><span class="table-header">Function Details</span></td>
221 <td align="right" valign="top"
222 ><span class="options">[<a href="#section-FunctionDetails"
223 class="privatelink" onclick="toggle_private();"
224 >hide private</a>]</span></td>
225 </tr>
226 </table>
227 </td>
228</tr>
229</table>
230<a name="makepatch"></a>
231<div>
232<table class="details" border="1" cellpadding="3"
233 cellspacing="0" width="100%" bgcolor="white">
234<tr><td>
235 <table width="100%" cellpadding="0" cellspacing="0" border="0">
236 <tr valign="top"><td>
237 <h3 class="epydoc"><span class="sig"><span class="sig-name">makepatch</span>(<span class="sig-arg">original</span>,
238 <span class="sig-arg">modified</span>)</span>
239 </h3>
240 </td><td align="right" valign="top"
241 ><span class="codelink"><a href="apiclient.model-pysrc.html#makepatch">source&nbsp;code</a></span>&nbsp;
242 </td>
243 </tr></table>
244
245 <pre class="literalblock">
246Create a patch object.
247
248Some methods support PATCH, an efficient way to send updates to a resource.
249This method allows the easy construction of patch bodies by looking at the
250differences between a resource before and after it was modified.
251
252Args:
253 original: object, the original deserialized resource
254 modified: object, the modified deserialized resource
255Returns:
256 An object that contains only the changes from original to modified, in a
257 form suitable to pass to a PATCH method.
258
259Example usage:
260 item = service.activities().get(postid=postid, userid=userid).execute()
261 original = copy.deepcopy(item)
262 item['object']['content'] = 'This is updated.'
263 service.activities.patch(postid=postid, userid=userid,
264 body=makepatch(original, item)).execute()
265
266</pre>
267 <dl class="fields">
268 </dl>
269</td></tr></table>
270</div>
271<br />
272<!-- ==================== NAVIGATION BAR ==================== -->
273<table class="navbar" border="0" width="100%" cellpadding="0"
274 bgcolor="#a0c0ff" cellspacing="0">
275 <tr valign="middle">
276
277 <!-- Tree link -->
278 <th>&nbsp;&nbsp;&nbsp;<a
279 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
280
281 <!-- Index link -->
282 <th>&nbsp;&nbsp;&nbsp;<a
283 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
284
285 <!-- Help link -->
286 <th>&nbsp;&nbsp;&nbsp;<a
287 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
288
289 <th class="navbar" width="100%"></th>
290 </tr>
291</table>
292<table border="0" cellpadding="0" cellspacing="0" width="100%%">
293 <tr>
294 <td align="left" class="footer">
295 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012
296 </td>
297 <td align="right" class="footer">
298 <a target="mainFrame" href="http://epydoc.sourceforge.net"
299 >http://epydoc.sourceforge.net</a>
300 </td>
301 </tr>
302</table>
303
304<script type="text/javascript">
305 <!--
306 // Private objects are initially displayed (because if
307 // javascript is turned off then we want them to be
308 // visible); but by default, we want to hide them. So hide
309 // them unless we have a cookie that says to show them.
310 checkCookie();
311 // -->
312</script>
313</body>
314</html>