Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / epy / googleapiclient.model-module.html
blob: 9a3be595c61b73ab66522560815252326f62c1b7 [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>
208<tr>
209 <td width="15%" align="right" valign="top" class="summary">
210 <span class="summary-type">&nbsp;</span>
211 </td><td class="summary">
212 <a name="dump_request_response"></a><span class="summary-name">dump_request_response</span> = <code title="False">False</code>
213 </td>
214 </tr>
215</table>
216<!-- ==================== FUNCTION DETAILS ==================== -->
217<a name="section-FunctionDetails"></a>
218<table class="details" border="1" cellpadding="3"
219 cellspacing="0" width="100%" bgcolor="white">
220<tr bgcolor="#70b0f0" class="table-header">
221 <td colspan="2" class="table-header">
222 <table border="0" cellpadding="0" cellspacing="0" width="100%">
223 <tr valign="top">
224 <td align="left"><span class="table-header">Function Details</span></td>
225 <td align="right" valign="top"
226 ><span class="options">[<a href="#section-FunctionDetails"
227 class="privatelink" onclick="toggle_private();"
228 >hide private</a>]</span></td>
229 </tr>
230 </table>
231 </td>
232</tr>
233</table>
234<a name="makepatch"></a>
235<div>
236<table class="details" border="1" cellpadding="3"
237 cellspacing="0" width="100%" bgcolor="white">
238<tr><td>
239 <table width="100%" cellpadding="0" cellspacing="0" border="0">
240 <tr valign="top"><td>
241 <h3 class="epydoc"><span class="sig"><span class="sig-name">makepatch</span>(<span class="sig-arg">original</span>,
242 <span class="sig-arg">modified</span>)</span>
243 </h3>
244 </td><td align="right" valign="top"
245 ><span class="codelink"><a href="googleapiclient.model-pysrc.html#makepatch">source&nbsp;code</a></span>&nbsp;
246 </td>
247 </tr></table>
248
249 <pre class="literalblock">
250Create a patch object.
251
252Some methods support PATCH, an efficient way to send updates to a resource.
253This method allows the easy construction of patch bodies by looking at the
254differences between a resource before and after it was modified.
255
256Args:
257 original: object, the original deserialized resource
258 modified: object, the modified deserialized resource
259Returns:
260 An object that contains only the changes from original to modified, in a
261 form suitable to pass to a PATCH method.
262
263Example usage:
264 item = service.activities().get(postid=postid, userid=userid).execute()
265 original = copy.deepcopy(item)
266 item['object']['content'] = 'This is updated.'
267 service.activities.patch(postid=postid, userid=userid,
268 body=makepatch(original, item)).execute()
269
270</pre>
271 <dl class="fields">
272 </dl>
273</td></tr></table>
274</div>
275<br />
276<!-- ==================== NAVIGATION BAR ==================== -->
277<table class="navbar" border="0" width="100%" cellpadding="0"
278 bgcolor="#a0c0ff" cellspacing="0">
279 <tr valign="middle">
280 <!-- Home link -->
281 <th>&nbsp;&nbsp;&nbsp;<a
282 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
283
284 <!-- Tree link -->
285 <th>&nbsp;&nbsp;&nbsp;<a
286 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
287
288 <!-- Index link -->
289 <th>&nbsp;&nbsp;&nbsp;<a
290 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
291
292 <!-- Help link -->
293 <th>&nbsp;&nbsp;&nbsp;<a
294 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
295
296 <th class="navbar" width="100%"></th>
297 </tr>
298</table>
299<table border="0" cellpadding="0" cellspacing="0" width="100%%">
300 <tr>
301 <td align="left" class="footer">
302 Generated by Epydoc 3.0.1 on Thu Apr 24 15:46:09 2014
303 </td>
304 <td align="right" class="footer">
305 <a target="mainFrame" href="http://epydoc.sourceforge.net"
306 >http://epydoc.sourceforge.net</a>
307 </td>
308 </tr>
309</table>
310
311<script type="text/javascript">
312 <!--
313 // Private objects are initially displayed (because if
314 // javascript is turned off then we want them to be
315 // visible); but by default, we want to hide them. So hide
316 // them unless we have a cookie that says to show them.
317 checkCookie();
318 // -->
319</script>
320</body>
321</html>