blob: 17541233ae107e6dd136c79cb552583d5a3a8f08 [file] [log] [blame]
Joe Gregorio30dfdc32010-12-09 16:34:22 -05001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module apiclient.model</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.model</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregorio66212032012-06-14 09:10:14 -040011><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/clean/apiclient/model.py">/home/jcgregorio/projects/clean/apiclient/model.py</a></font></td></tr></table>
Joe Gregorio3b79fa82011-02-17 11:47:17 -050012 <p><tt><a href="#Model">Model</a>&nbsp;objects&nbsp;for&nbsp;requests&nbsp;and&nbsp;responses.<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050013&nbsp;<br>
14Each&nbsp;API&nbsp;may&nbsp;support&nbsp;one&nbsp;or&nbsp;more&nbsp;serializations,&nbsp;such<br>
15as&nbsp;JSON,&nbsp;Atom,&nbsp;etc.&nbsp;The&nbsp;model&nbsp;classes&nbsp;are&nbsp;responsible<br>
16for&nbsp;converting&nbsp;between&nbsp;the&nbsp;wire&nbsp;format&nbsp;and&nbsp;the&nbsp;Python<br>
17<a href="__builtin__.html#object">object</a>&nbsp;representation.</tt></p>
18<p>
19<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
20<tr bgcolor="#aa55cc">
21<td colspan=3 valign=bottom>&nbsp;<br>
22<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
23
24<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorio49396552011-03-08 10:39:00 -050025<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="gflags.html">gflags</a><br>
26</td><td width="25%" valign=top><a href="logging.html">logging</a><br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -050027</td><td width="25%" valign=top><a href="json.html">json</a><br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050028</td><td width="25%" valign=top><a href="urllib.html">urllib</a><br>
Joe Gregorio49396552011-03-08 10:39:00 -050029</td></tr></table></td></tr></table><p>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050030<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
31<tr bgcolor="#ee77aa">
32<td colspan=3 valign=bottom>&nbsp;<br>
33<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
34
35<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
36<td width="100%"><dl>
37<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
38</font></dt><dd>
39<dl>
Joe Gregorioabda96f2011-02-11 20:19:33 -050040<dt><font face="helvetica, arial"><a href="apiclient.model.html#Model">Model</a>
41</font></dt><dd>
42<dl>
Joe Gregorio351b1492011-05-08 23:32:46 -070043<dt><font face="helvetica, arial"><a href="apiclient.model.html#BaseModel">BaseModel</a>
Joe Gregorio49396552011-03-08 10:39:00 -050044</font></dt><dd>
45<dl>
Joe Gregorio351b1492011-05-08 23:32:46 -070046<dt><font face="helvetica, arial"><a href="apiclient.model.html#JsonModel">JsonModel</a>
Joe Gregoriob417caf2011-12-08 12:04:24 -050047</font></dt><dd>
48<dl>
Joe Gregorioebd0b842012-06-15 14:14:17 -040049<dt><font face="helvetica, arial"><a href="apiclient.model.html#MediaModel">MediaModel</a>
50</font></dt><dt><font face="helvetica, arial"><a href="apiclient.model.html#RawModel">RawModel</a>
Joe Gregoriob417caf2011-12-08 12:04:24 -050051</font></dt></dl>
52</dd>
53<dt><font face="helvetica, arial"><a href="apiclient.model.html#ProtocolBufferModel">ProtocolBufferModel</a>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050054</font></dt></dl>
55</dd>
56</dl>
Joe Gregorioabda96f2011-02-11 20:19:33 -050057</dd>
58</dl>
Joe Gregorio49396552011-03-08 10:39:00 -050059</dd>
60</dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050061 <p>
62<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
63<tr bgcolor="#ffc8d8">
64<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorio351b1492011-05-08 23:32:46 -070065<font color="#000000" face="helvetica, arial"><a name="BaseModel">class <strong>BaseModel</strong></a>(<a href="apiclient.model.html#Model">Model</a>)</font></td></tr>
66
67<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
68<td colspan=2><tt>Base&nbsp;model&nbsp;class.<br>
69&nbsp;<br>
70Subclasses&nbsp;should&nbsp;provide&nbsp;implementations&nbsp;for&nbsp;the&nbsp;"serialize"&nbsp;and<br>
71"deserialize"&nbsp;methods,&nbsp;as&nbsp;well&nbsp;as&nbsp;values&nbsp;for&nbsp;the&nbsp;following&nbsp;class&nbsp;attributes.<br>
72&nbsp;<br>
73Attributes:<br>
74&nbsp;&nbsp;accept:&nbsp;The&nbsp;value&nbsp;to&nbsp;use&nbsp;for&nbsp;the&nbsp;HTTP&nbsp;Accept&nbsp;header.<br>
75&nbsp;&nbsp;content_type:&nbsp;The&nbsp;value&nbsp;to&nbsp;use&nbsp;for&nbsp;the&nbsp;HTTP&nbsp;Content-type&nbsp;header.<br>
76&nbsp;&nbsp;no_content_response:&nbsp;The&nbsp;value&nbsp;to&nbsp;return&nbsp;when&nbsp;deserializing&nbsp;a&nbsp;204&nbsp;"No<br>
77&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Content"&nbsp;response.<br>
78&nbsp;&nbsp;alt_param:&nbsp;The&nbsp;value&nbsp;to&nbsp;supply&nbsp;as&nbsp;the&nbsp;"alt"&nbsp;query&nbsp;parameter&nbsp;for&nbsp;requests.<br>&nbsp;</tt></td></tr>
79<tr><td>&nbsp;</td>
80<td width="100%"><dl><dt>Method resolution order:</dt>
81<dd><a href="apiclient.model.html#BaseModel">BaseModel</a></dd>
82<dd><a href="apiclient.model.html#Model">Model</a></dd>
83<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
84</dl>
85<hr>
86Methods defined here:<br>
Joe Gregorioa8451672011-09-15 09:53:21 -040087<dl><dt><a name="BaseModel-deserialize"><strong>deserialize</strong></a>(self, content)</dt><dd><tt>Perform&nbsp;the&nbsp;actual&nbsp;deserialization&nbsp;from&nbsp;response&nbsp;string&nbsp;to&nbsp;Python<br>
88<a href="__builtin__.html#object">object</a>.<br>
Joe Gregorio351b1492011-05-08 23:32:46 -070089&nbsp;<br>
90Args:<br>
91&nbsp;&nbsp;content:&nbsp;string,&nbsp;the&nbsp;body&nbsp;of&nbsp;the&nbsp;HTTP&nbsp;response<br>
92&nbsp;<br>
93Returns:<br>
94&nbsp;&nbsp;The&nbsp;body&nbsp;de-serialized&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.</tt></dd></dl>
95
96<dl><dt><a name="BaseModel-request"><strong>request</strong></a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates&nbsp;outgoing&nbsp;requests&nbsp;with&nbsp;a&nbsp;serialized&nbsp;body.<br>
97&nbsp;<br>
98Args:<br>
99&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
100&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
101&nbsp;&nbsp;query_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;query<br>
102&nbsp;&nbsp;body_value:&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;the&nbsp;request&nbsp;body&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;which&nbsp;must&nbsp;be<br>
103&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serializable&nbsp;by&nbsp;simplejson.<br>
104Returns:<br>
105&nbsp;&nbsp;A&nbsp;tuple&nbsp;of&nbsp;(headers,&nbsp;path_params,&nbsp;query,&nbsp;body)<br>
106&nbsp;<br>
107&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
108&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
109&nbsp;&nbsp;query:&nbsp;string,&nbsp;query&nbsp;part&nbsp;of&nbsp;the&nbsp;request&nbsp;URI<br>
110&nbsp;&nbsp;body:&nbsp;string,&nbsp;the&nbsp;body&nbsp;serialized&nbsp;as&nbsp;JSON</tt></dd></dl>
111
112<dl><dt><a name="BaseModel-response"><strong>response</strong></a>(self, resp, content)</dt><dd><tt>Convert&nbsp;the&nbsp;response&nbsp;wire&nbsp;format&nbsp;into&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
113&nbsp;<br>
114Args:<br>
115&nbsp;&nbsp;resp:&nbsp;httplib2.Response,&nbsp;the&nbsp;HTTP&nbsp;response&nbsp;headers&nbsp;and&nbsp;status<br>
116&nbsp;&nbsp;content:&nbsp;string,&nbsp;the&nbsp;body&nbsp;of&nbsp;the&nbsp;HTTP&nbsp;response<br>
117&nbsp;<br>
118Returns:<br>
119&nbsp;&nbsp;The&nbsp;body&nbsp;de-serialized&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
120&nbsp;<br>
121Raises:<br>
122&nbsp;&nbsp;apiclient.errors.HttpError&nbsp;if&nbsp;a&nbsp;non&nbsp;2xx&nbsp;response&nbsp;is&nbsp;received.</tt></dd></dl>
123
124<dl><dt><a name="BaseModel-serialize"><strong>serialize</strong></a>(self, body_value)</dt><dd><tt>Perform&nbsp;the&nbsp;actual&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;serialization.<br>
125&nbsp;<br>
126Args:<br>
127&nbsp;&nbsp;body_value:&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;the&nbsp;request&nbsp;body&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
128&nbsp;<br>
129Returns:<br>
130&nbsp;&nbsp;string,&nbsp;the&nbsp;body&nbsp;in&nbsp;serialized&nbsp;form.</tt></dd></dl>
131
132<hr>
133Data and other attributes defined here:<br>
134<dl><dt><strong>accept</strong> = None</dl>
135
136<dl><dt><strong>alt_param</strong> = None</dl>
137
138<dl><dt><strong>content_type</strong> = None</dl>
139
140<dl><dt><strong>no_content_response</strong> = None</dl>
141
142<hr>
143Data descriptors inherited from <a href="apiclient.model.html#Model">Model</a>:<br>
144<dl><dt><strong>__dict__</strong></dt>
145<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
146</dl>
147<dl><dt><strong>__weakref__</strong></dt>
148<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
149</dl>
150</td></tr></table> <p>
151<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
152<tr bgcolor="#ffc8d8">
153<td colspan=3 valign=bottom>&nbsp;<br>
154<font color="#000000" face="helvetica, arial"><a name="JsonModel">class <strong>JsonModel</strong></a>(<a href="apiclient.model.html#BaseModel">BaseModel</a>)</font></td></tr>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500155
156<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500157<td colspan=2><tt><a href="#Model">Model</a>&nbsp;class&nbsp;for&nbsp;JSON.<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500158&nbsp;<br>
159Serializes&nbsp;and&nbsp;de-serializes&nbsp;between&nbsp;JSON&nbsp;and&nbsp;the&nbsp;Python<br>
160<a href="__builtin__.html#object">object</a>&nbsp;representation&nbsp;of&nbsp;HTTP&nbsp;request&nbsp;and&nbsp;response&nbsp;bodies.<br>&nbsp;</tt></td></tr>
161<tr><td>&nbsp;</td>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500162<td width="100%"><dl><dt>Method resolution order:</dt>
163<dd><a href="apiclient.model.html#JsonModel">JsonModel</a></dd>
Joe Gregorio351b1492011-05-08 23:32:46 -0700164<dd><a href="apiclient.model.html#BaseModel">BaseModel</a></dd>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500165<dd><a href="apiclient.model.html#Model">Model</a></dd>
166<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
167</dl>
168<hr>
169Methods defined here:<br>
Joe Gregorio351b1492011-05-08 23:32:46 -0700170<dl><dt><a name="JsonModel-__init__"><strong>__init__</strong></a>(self, data_wrapper<font color="#909090">=False</font>)</dt><dd><tt>Construct&nbsp;a&nbsp;<a href="#JsonModel">JsonModel</a>.<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500171&nbsp;<br>
172Args:<br>
173&nbsp;&nbsp;data_wrapper:&nbsp;boolean,&nbsp;wrap&nbsp;requests&nbsp;and&nbsp;responses&nbsp;in&nbsp;a&nbsp;data&nbsp;wrapper</tt></dd></dl>
174
Joe Gregorio351b1492011-05-08 23:32:46 -0700175<dl><dt><a name="JsonModel-deserialize"><strong>deserialize</strong></a>(self, content)</dt></dl>
176
177<dl><dt><a name="JsonModel-serialize"><strong>serialize</strong></a>(self, body_value)</dt></dl>
178
179<hr>
180Data descriptors defined here:<br>
181<dl><dt><strong>no_content_response</strong></dt>
182</dl>
183<hr>
184Data and other attributes defined here:<br>
185<dl><dt><strong>accept</strong> = 'application/json'</dl>
186
187<dl><dt><strong>alt_param</strong> = 'json'</dl>
188
189<dl><dt><strong>content_type</strong> = 'application/json'</dl>
190
191<hr>
192Methods inherited from <a href="apiclient.model.html#BaseModel">BaseModel</a>:<br>
193<dl><dt><a name="JsonModel-request"><strong>request</strong></a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates&nbsp;outgoing&nbsp;requests&nbsp;with&nbsp;a&nbsp;serialized&nbsp;body.<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500194&nbsp;<br>
195Args:<br>
196&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
197&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
198&nbsp;&nbsp;query_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;query<br>
199&nbsp;&nbsp;body_value:&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;the&nbsp;request&nbsp;body&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;which&nbsp;must&nbsp;be<br>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serializable&nbsp;by&nbsp;simplejson.<br>
201Returns:<br>
202&nbsp;&nbsp;A&nbsp;tuple&nbsp;of&nbsp;(headers,&nbsp;path_params,&nbsp;query,&nbsp;body)<br>
203&nbsp;<br>
204&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
205&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
206&nbsp;&nbsp;query:&nbsp;string,&nbsp;query&nbsp;part&nbsp;of&nbsp;the&nbsp;request&nbsp;URI<br>
207&nbsp;&nbsp;body:&nbsp;string,&nbsp;the&nbsp;body&nbsp;serialized&nbsp;as&nbsp;JSON</tt></dd></dl>
208
209<dl><dt><a name="JsonModel-response"><strong>response</strong></a>(self, resp, content)</dt><dd><tt>Convert&nbsp;the&nbsp;response&nbsp;wire&nbsp;format&nbsp;into&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
210&nbsp;<br>
211Args:<br>
212&nbsp;&nbsp;resp:&nbsp;httplib2.Response,&nbsp;the&nbsp;HTTP&nbsp;response&nbsp;headers&nbsp;and&nbsp;status<br>
213&nbsp;&nbsp;content:&nbsp;string,&nbsp;the&nbsp;body&nbsp;of&nbsp;the&nbsp;HTTP&nbsp;response<br>
214&nbsp;<br>
215Returns:<br>
216&nbsp;&nbsp;The&nbsp;body&nbsp;de-serialized&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
217&nbsp;<br>
218Raises:<br>
219&nbsp;&nbsp;apiclient.errors.HttpError&nbsp;if&nbsp;a&nbsp;non&nbsp;2xx&nbsp;response&nbsp;is&nbsp;received.</tt></dd></dl>
220
221<hr>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500222Data descriptors inherited from <a href="apiclient.model.html#Model">Model</a>:<br>
223<dl><dt><strong>__dict__</strong></dt>
224<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
225</dl>
226<dl><dt><strong>__weakref__</strong></dt>
227<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
228</dl>
229</td></tr></table> <p>
230<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
231<tr bgcolor="#ffc8d8">
232<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorioebd0b842012-06-15 14:14:17 -0400233<font color="#000000" face="helvetica, arial"><a name="MediaModel">class <strong>MediaModel</strong></a>(<a href="apiclient.model.html#JsonModel">JsonModel</a>)</font></td></tr>
234
235<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
236<td colspan=2><tt><a href="#Model">Model</a>&nbsp;class&nbsp;for&nbsp;requests&nbsp;that&nbsp;return&nbsp;Media.<br>
237&nbsp;<br>
238Serializes&nbsp;and&nbsp;de-serializes&nbsp;between&nbsp;JSON&nbsp;and&nbsp;the&nbsp;Python<br>
239<a href="__builtin__.html#object">object</a>&nbsp;representation&nbsp;of&nbsp;HTTP&nbsp;request,&nbsp;and&nbsp;returns&nbsp;the&nbsp;raw&nbsp;bytes<br>
240of&nbsp;the&nbsp;response&nbsp;body.<br>&nbsp;</tt></td></tr>
241<tr><td>&nbsp;</td>
242<td width="100%"><dl><dt>Method resolution order:</dt>
243<dd><a href="apiclient.model.html#MediaModel">MediaModel</a></dd>
244<dd><a href="apiclient.model.html#JsonModel">JsonModel</a></dd>
245<dd><a href="apiclient.model.html#BaseModel">BaseModel</a></dd>
246<dd><a href="apiclient.model.html#Model">Model</a></dd>
247<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
248</dl>
249<hr>
250Methods defined here:<br>
251<dl><dt><a name="MediaModel-deserialize"><strong>deserialize</strong></a>(self, content)</dt></dl>
252
253<hr>
254Data descriptors defined here:<br>
255<dl><dt><strong>no_content_response</strong></dt>
256</dl>
257<hr>
258Data and other attributes defined here:<br>
259<dl><dt><strong>accept</strong> = '*/*'</dl>
260
261<dl><dt><strong>alt_param</strong> = 'media'</dl>
262
263<dl><dt><strong>content_type</strong> = 'application/json'</dl>
264
265<hr>
266Methods inherited from <a href="apiclient.model.html#JsonModel">JsonModel</a>:<br>
267<dl><dt><a name="MediaModel-__init__"><strong>__init__</strong></a>(self, data_wrapper<font color="#909090">=False</font>)</dt><dd><tt>Construct&nbsp;a&nbsp;<a href="#JsonModel">JsonModel</a>.<br>
268&nbsp;<br>
269Args:<br>
270&nbsp;&nbsp;data_wrapper:&nbsp;boolean,&nbsp;wrap&nbsp;requests&nbsp;and&nbsp;responses&nbsp;in&nbsp;a&nbsp;data&nbsp;wrapper</tt></dd></dl>
271
272<dl><dt><a name="MediaModel-serialize"><strong>serialize</strong></a>(self, body_value)</dt></dl>
273
274<hr>
275Methods inherited from <a href="apiclient.model.html#BaseModel">BaseModel</a>:<br>
276<dl><dt><a name="MediaModel-request"><strong>request</strong></a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates&nbsp;outgoing&nbsp;requests&nbsp;with&nbsp;a&nbsp;serialized&nbsp;body.<br>
277&nbsp;<br>
278Args:<br>
279&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
280&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
281&nbsp;&nbsp;query_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;query<br>
282&nbsp;&nbsp;body_value:&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;the&nbsp;request&nbsp;body&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;which&nbsp;must&nbsp;be<br>
283&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serializable&nbsp;by&nbsp;simplejson.<br>
284Returns:<br>
285&nbsp;&nbsp;A&nbsp;tuple&nbsp;of&nbsp;(headers,&nbsp;path_params,&nbsp;query,&nbsp;body)<br>
286&nbsp;<br>
287&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
288&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
289&nbsp;&nbsp;query:&nbsp;string,&nbsp;query&nbsp;part&nbsp;of&nbsp;the&nbsp;request&nbsp;URI<br>
290&nbsp;&nbsp;body:&nbsp;string,&nbsp;the&nbsp;body&nbsp;serialized&nbsp;as&nbsp;JSON</tt></dd></dl>
291
292<dl><dt><a name="MediaModel-response"><strong>response</strong></a>(self, resp, content)</dt><dd><tt>Convert&nbsp;the&nbsp;response&nbsp;wire&nbsp;format&nbsp;into&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
293&nbsp;<br>
294Args:<br>
295&nbsp;&nbsp;resp:&nbsp;httplib2.Response,&nbsp;the&nbsp;HTTP&nbsp;response&nbsp;headers&nbsp;and&nbsp;status<br>
296&nbsp;&nbsp;content:&nbsp;string,&nbsp;the&nbsp;body&nbsp;of&nbsp;the&nbsp;HTTP&nbsp;response<br>
297&nbsp;<br>
298Returns:<br>
299&nbsp;&nbsp;The&nbsp;body&nbsp;de-serialized&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
300&nbsp;<br>
301Raises:<br>
302&nbsp;&nbsp;apiclient.errors.HttpError&nbsp;if&nbsp;a&nbsp;non&nbsp;2xx&nbsp;response&nbsp;is&nbsp;received.</tt></dd></dl>
303
304<hr>
305Data descriptors inherited from <a href="apiclient.model.html#Model">Model</a>:<br>
306<dl><dt><strong>__dict__</strong></dt>
307<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
308</dl>
309<dl><dt><strong>__weakref__</strong></dt>
310<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
311</dl>
312</td></tr></table> <p>
313<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
314<tr bgcolor="#ffc8d8">
315<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500316<font color="#000000" face="helvetica, arial"><a name="Model">class <strong>Model</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
317
318<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
319<td colspan=2><tt><a href="#Model">Model</a>&nbsp;base&nbsp;class.<br>
320&nbsp;<br>
321All&nbsp;<a href="#Model">Model</a>&nbsp;classes&nbsp;should&nbsp;implement&nbsp;this&nbsp;interface.<br>
322The&nbsp;<a href="#Model">Model</a>&nbsp;serializes&nbsp;and&nbsp;de-serializes&nbsp;between&nbsp;a&nbsp;wire<br>
323format&nbsp;such&nbsp;as&nbsp;JSON&nbsp;and&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;representation.<br>&nbsp;</tt></td></tr>
324<tr><td>&nbsp;</td>
325<td width="100%">Methods defined here:<br>
Joe Gregorio351b1492011-05-08 23:32:46 -0700326<dl><dt><a name="Model-request"><strong>request</strong></a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates&nbsp;outgoing&nbsp;requests&nbsp;with&nbsp;a&nbsp;serialized&nbsp;body.<br>
Joe Gregorioabda96f2011-02-11 20:19:33 -0500327&nbsp;<br>
328Args:<br>
329&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
330&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
331&nbsp;&nbsp;query_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;query<br>
332&nbsp;&nbsp;body_value:&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;the&nbsp;request&nbsp;body&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;which&nbsp;must&nbsp;be<br>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serializable.<br>
334Returns:<br>
335&nbsp;&nbsp;A&nbsp;tuple&nbsp;of&nbsp;(headers,&nbsp;path_params,&nbsp;query,&nbsp;body)<br>
336&nbsp;<br>
337&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
338&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
339&nbsp;&nbsp;query:&nbsp;string,&nbsp;query&nbsp;part&nbsp;of&nbsp;the&nbsp;request&nbsp;URI<br>
340&nbsp;&nbsp;body:&nbsp;string,&nbsp;the&nbsp;body&nbsp;serialized&nbsp;in&nbsp;the&nbsp;desired&nbsp;wire&nbsp;format.</tt></dd></dl>
341
342<dl><dt><a name="Model-response"><strong>response</strong></a>(self, resp, content)</dt><dd><tt>Convert&nbsp;the&nbsp;response&nbsp;wire&nbsp;format&nbsp;into&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
343&nbsp;<br>
344Args:<br>
345&nbsp;&nbsp;resp:&nbsp;httplib2.Response,&nbsp;the&nbsp;HTTP&nbsp;response&nbsp;headers&nbsp;and&nbsp;status<br>
346&nbsp;&nbsp;content:&nbsp;string,&nbsp;the&nbsp;body&nbsp;of&nbsp;the&nbsp;HTTP&nbsp;response<br>
347&nbsp;<br>
348Returns:<br>
349&nbsp;&nbsp;The&nbsp;body&nbsp;de-serialized&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
350&nbsp;<br>
351Raises:<br>
352&nbsp;&nbsp;apiclient.errors.HttpError&nbsp;if&nbsp;a&nbsp;non&nbsp;2xx&nbsp;response&nbsp;is&nbsp;received.</tt></dd></dl>
353
354<hr>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500355Data descriptors defined here:<br>
356<dl><dt><strong>__dict__</strong></dt>
357<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
358</dl>
359<dl><dt><strong>__weakref__</strong></dt>
360<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
361</dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700362</td></tr></table> <p>
363<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
364<tr bgcolor="#ffc8d8">
365<td colspan=3 valign=bottom>&nbsp;<br>
366<font color="#000000" face="helvetica, arial"><a name="ProtocolBufferModel">class <strong>ProtocolBufferModel</strong></a>(<a href="apiclient.model.html#BaseModel">BaseModel</a>)</font></td></tr>
367
368<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
369<td colspan=2><tt><a href="#Model">Model</a>&nbsp;class&nbsp;for&nbsp;protocol&nbsp;buffers.<br>
370&nbsp;<br>
371Serializes&nbsp;and&nbsp;de-serializes&nbsp;the&nbsp;binary&nbsp;protocol&nbsp;buffer&nbsp;sent&nbsp;in&nbsp;the&nbsp;HTTP<br>
372request&nbsp;and&nbsp;response&nbsp;bodies.<br>&nbsp;</tt></td></tr>
373<tr><td>&nbsp;</td>
374<td width="100%"><dl><dt>Method resolution order:</dt>
375<dd><a href="apiclient.model.html#ProtocolBufferModel">ProtocolBufferModel</a></dd>
376<dd><a href="apiclient.model.html#BaseModel">BaseModel</a></dd>
377<dd><a href="apiclient.model.html#Model">Model</a></dd>
378<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
379</dl>
380<hr>
381Methods defined here:<br>
382<dl><dt><a name="ProtocolBufferModel-__init__"><strong>__init__</strong></a>(self, protocol_buffer)</dt><dd><tt>Constructs&nbsp;a&nbsp;<a href="#ProtocolBufferModel">ProtocolBufferModel</a>.<br>
383&nbsp;<br>
384The&nbsp;serialzed&nbsp;protocol&nbsp;buffer&nbsp;returned&nbsp;in&nbsp;an&nbsp;HTTP&nbsp;response&nbsp;will&nbsp;be<br>
385de-serialized&nbsp;using&nbsp;the&nbsp;given&nbsp;protocol&nbsp;buffer&nbsp;class.<br>
386&nbsp;<br>
387Args:<br>
Joe Gregorioa8451672011-09-15 09:53:21 -0400388&nbsp;&nbsp;protocol_buffer:&nbsp;The&nbsp;protocol&nbsp;buffer&nbsp;class&nbsp;used&nbsp;to&nbsp;de-serialize&nbsp;a<br>
389&nbsp;&nbsp;response&nbsp;from&nbsp;the&nbsp;API.</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700390
391<dl><dt><a name="ProtocolBufferModel-deserialize"><strong>deserialize</strong></a>(self, content)</dt></dl>
392
393<dl><dt><a name="ProtocolBufferModel-serialize"><strong>serialize</strong></a>(self, body_value)</dt></dl>
394
395<hr>
396Data descriptors defined here:<br>
397<dl><dt><strong>no_content_response</strong></dt>
398</dl>
399<hr>
400Data and other attributes defined here:<br>
401<dl><dt><strong>accept</strong> = 'application/x-protobuf'</dl>
402
403<dl><dt><strong>alt_param</strong> = 'proto'</dl>
404
405<dl><dt><strong>content_type</strong> = 'application/x-protobuf'</dl>
406
407<hr>
408Methods inherited from <a href="apiclient.model.html#BaseModel">BaseModel</a>:<br>
409<dl><dt><a name="ProtocolBufferModel-request"><strong>request</strong></a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates&nbsp;outgoing&nbsp;requests&nbsp;with&nbsp;a&nbsp;serialized&nbsp;body.<br>
410&nbsp;<br>
411Args:<br>
412&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
413&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
414&nbsp;&nbsp;query_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;query<br>
415&nbsp;&nbsp;body_value:&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;the&nbsp;request&nbsp;body&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;which&nbsp;must&nbsp;be<br>
416&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serializable&nbsp;by&nbsp;simplejson.<br>
417Returns:<br>
418&nbsp;&nbsp;A&nbsp;tuple&nbsp;of&nbsp;(headers,&nbsp;path_params,&nbsp;query,&nbsp;body)<br>
419&nbsp;<br>
420&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
421&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
422&nbsp;&nbsp;query:&nbsp;string,&nbsp;query&nbsp;part&nbsp;of&nbsp;the&nbsp;request&nbsp;URI<br>
423&nbsp;&nbsp;body:&nbsp;string,&nbsp;the&nbsp;body&nbsp;serialized&nbsp;as&nbsp;JSON</tt></dd></dl>
424
425<dl><dt><a name="ProtocolBufferModel-response"><strong>response</strong></a>(self, resp, content)</dt><dd><tt>Convert&nbsp;the&nbsp;response&nbsp;wire&nbsp;format&nbsp;into&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
426&nbsp;<br>
427Args:<br>
428&nbsp;&nbsp;resp:&nbsp;httplib2.Response,&nbsp;the&nbsp;HTTP&nbsp;response&nbsp;headers&nbsp;and&nbsp;status<br>
429&nbsp;&nbsp;content:&nbsp;string,&nbsp;the&nbsp;body&nbsp;of&nbsp;the&nbsp;HTTP&nbsp;response<br>
430&nbsp;<br>
431Returns:<br>
432&nbsp;&nbsp;The&nbsp;body&nbsp;de-serialized&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
433&nbsp;<br>
434Raises:<br>
435&nbsp;&nbsp;apiclient.errors.HttpError&nbsp;if&nbsp;a&nbsp;non&nbsp;2xx&nbsp;response&nbsp;is&nbsp;received.</tt></dd></dl>
436
437<hr>
438Data descriptors inherited from <a href="apiclient.model.html#Model">Model</a>:<br>
439<dl><dt><strong>__dict__</strong></dt>
440<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
441</dl>
442<dl><dt><strong>__weakref__</strong></dt>
443<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
444</dl>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500445</td></tr></table> <p>
446<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
447<tr bgcolor="#ffc8d8">
448<td colspan=3 valign=bottom>&nbsp;<br>
449<font color="#000000" face="helvetica, arial"><a name="RawModel">class <strong>RawModel</strong></a>(<a href="apiclient.model.html#JsonModel">JsonModel</a>)</font></td></tr>
450
451<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
452<td colspan=2><tt><a href="#Model">Model</a>&nbsp;class&nbsp;for&nbsp;requests&nbsp;that&nbsp;don't&nbsp;return&nbsp;JSON.<br>
453&nbsp;<br>
454Serializes&nbsp;and&nbsp;de-serializes&nbsp;between&nbsp;JSON&nbsp;and&nbsp;the&nbsp;Python<br>
455<a href="__builtin__.html#object">object</a>&nbsp;representation&nbsp;of&nbsp;HTTP&nbsp;request,&nbsp;and&nbsp;returns&nbsp;the&nbsp;raw&nbsp;bytes<br>
456of&nbsp;the&nbsp;response&nbsp;body.<br>&nbsp;</tt></td></tr>
457<tr><td>&nbsp;</td>
458<td width="100%"><dl><dt>Method resolution order:</dt>
459<dd><a href="apiclient.model.html#RawModel">RawModel</a></dd>
460<dd><a href="apiclient.model.html#JsonModel">JsonModel</a></dd>
461<dd><a href="apiclient.model.html#BaseModel">BaseModel</a></dd>
462<dd><a href="apiclient.model.html#Model">Model</a></dd>
463<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
464</dl>
465<hr>
466Methods defined here:<br>
467<dl><dt><a name="RawModel-deserialize"><strong>deserialize</strong></a>(self, content)</dt></dl>
468
469<hr>
470Data descriptors defined here:<br>
471<dl><dt><strong>no_content_response</strong></dt>
472</dl>
473<hr>
474Data and other attributes defined here:<br>
475<dl><dt><strong>accept</strong> = '*/*'</dl>
476
477<dl><dt><strong>alt_param</strong> = None</dl>
478
479<dl><dt><strong>content_type</strong> = 'application/json'</dl>
480
481<hr>
482Methods inherited from <a href="apiclient.model.html#JsonModel">JsonModel</a>:<br>
483<dl><dt><a name="RawModel-__init__"><strong>__init__</strong></a>(self, data_wrapper<font color="#909090">=False</font>)</dt><dd><tt>Construct&nbsp;a&nbsp;<a href="#JsonModel">JsonModel</a>.<br>
484&nbsp;<br>
485Args:<br>
486&nbsp;&nbsp;data_wrapper:&nbsp;boolean,&nbsp;wrap&nbsp;requests&nbsp;and&nbsp;responses&nbsp;in&nbsp;a&nbsp;data&nbsp;wrapper</tt></dd></dl>
487
488<dl><dt><a name="RawModel-serialize"><strong>serialize</strong></a>(self, body_value)</dt></dl>
489
490<hr>
491Methods inherited from <a href="apiclient.model.html#BaseModel">BaseModel</a>:<br>
492<dl><dt><a name="RawModel-request"><strong>request</strong></a>(self, headers, path_params, query_params, body_value)</dt><dd><tt>Updates&nbsp;outgoing&nbsp;requests&nbsp;with&nbsp;a&nbsp;serialized&nbsp;body.<br>
493&nbsp;<br>
494Args:<br>
495&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
496&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
497&nbsp;&nbsp;query_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;query<br>
498&nbsp;&nbsp;body_value:&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;the&nbsp;request&nbsp;body&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;which&nbsp;must&nbsp;be<br>
499&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;serializable&nbsp;by&nbsp;simplejson.<br>
500Returns:<br>
501&nbsp;&nbsp;A&nbsp;tuple&nbsp;of&nbsp;(headers,&nbsp;path_params,&nbsp;query,&nbsp;body)<br>
502&nbsp;<br>
503&nbsp;&nbsp;headers:&nbsp;dict,&nbsp;request&nbsp;headers<br>
504&nbsp;&nbsp;path_params:&nbsp;dict,&nbsp;parameters&nbsp;that&nbsp;appear&nbsp;in&nbsp;the&nbsp;request&nbsp;path<br>
505&nbsp;&nbsp;query:&nbsp;string,&nbsp;query&nbsp;part&nbsp;of&nbsp;the&nbsp;request&nbsp;URI<br>
506&nbsp;&nbsp;body:&nbsp;string,&nbsp;the&nbsp;body&nbsp;serialized&nbsp;as&nbsp;JSON</tt></dd></dl>
507
508<dl><dt><a name="RawModel-response"><strong>response</strong></a>(self, resp, content)</dt><dd><tt>Convert&nbsp;the&nbsp;response&nbsp;wire&nbsp;format&nbsp;into&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
509&nbsp;<br>
510Args:<br>
511&nbsp;&nbsp;resp:&nbsp;httplib2.Response,&nbsp;the&nbsp;HTTP&nbsp;response&nbsp;headers&nbsp;and&nbsp;status<br>
512&nbsp;&nbsp;content:&nbsp;string,&nbsp;the&nbsp;body&nbsp;of&nbsp;the&nbsp;HTTP&nbsp;response<br>
513&nbsp;<br>
514Returns:<br>
515&nbsp;&nbsp;The&nbsp;body&nbsp;de-serialized&nbsp;as&nbsp;a&nbsp;Python&nbsp;<a href="__builtin__.html#object">object</a>.<br>
516&nbsp;<br>
517Raises:<br>
518&nbsp;&nbsp;apiclient.errors.HttpError&nbsp;if&nbsp;a&nbsp;non&nbsp;2xx&nbsp;response&nbsp;is&nbsp;received.</tt></dd></dl>
519
520<hr>
521Data descriptors inherited from <a href="apiclient.model.html#Model">Model</a>:<br>
522<dl><dt><strong>__dict__</strong></dt>
523<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
524</dl>
525<dl><dt><strong>__weakref__</strong></dt>
526<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
527</dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500528</td></tr></table></td></tr></table><p>
529<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400530<tr bgcolor="#eeaa77">
531<td colspan=3 valign=bottom>&nbsp;<br>
532<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
533
534<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
535<td width="100%"><dl><dt><a name="-makepatch"><strong>makepatch</strong></a>(original, modified)</dt><dd><tt>Create&nbsp;a&nbsp;patch&nbsp;<a href="__builtin__.html#object">object</a>.<br>
536&nbsp;<br>
537Some&nbsp;methods&nbsp;support&nbsp;PATCH,&nbsp;an&nbsp;efficient&nbsp;way&nbsp;to&nbsp;send&nbsp;updates&nbsp;to&nbsp;a&nbsp;resource.<br>
538This&nbsp;method&nbsp;allows&nbsp;the&nbsp;easy&nbsp;construction&nbsp;of&nbsp;patch&nbsp;bodies&nbsp;by&nbsp;looking&nbsp;at&nbsp;the<br>
539differences&nbsp;between&nbsp;a&nbsp;resource&nbsp;before&nbsp;and&nbsp;after&nbsp;it&nbsp;was&nbsp;modified.<br>
540&nbsp;<br>
541Args:<br>
542&nbsp;&nbsp;original:&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;the&nbsp;original&nbsp;deserialized&nbsp;resource<br>
543&nbsp;&nbsp;modified:&nbsp;<a href="__builtin__.html#object">object</a>,&nbsp;the&nbsp;modified&nbsp;deserialized&nbsp;resource<br>
544Returns:<br>
545&nbsp;&nbsp;An&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;that&nbsp;contains&nbsp;only&nbsp;the&nbsp;changes&nbsp;from&nbsp;original&nbsp;to&nbsp;modified,&nbsp;in&nbsp;a<br>
546&nbsp;&nbsp;form&nbsp;suitable&nbsp;to&nbsp;pass&nbsp;to&nbsp;a&nbsp;PATCH&nbsp;method.<br>
547&nbsp;<br>
548Example&nbsp;usage:<br>
549&nbsp;&nbsp;item&nbsp;=&nbsp;service.activities().get(postid=postid,&nbsp;userid=userid).execute()<br>
550&nbsp;&nbsp;original&nbsp;=&nbsp;copy.deepcopy(item)<br>
551&nbsp;&nbsp;item['<a href="__builtin__.html#object">object</a>']['content']&nbsp;=&nbsp;'This&nbsp;is&nbsp;updated.'<br>
552&nbsp;&nbsp;service.activities.patch(postid=postid,&nbsp;userid=userid,<br>
553&nbsp;&nbsp;&nbsp;&nbsp;body=<a href="#-makepatch">makepatch</a>(original,&nbsp;item)).execute()</tt></dd></dl>
554</td></tr></table><p>
555<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500556<tr bgcolor="#55aa55">
557<td colspan=3 valign=bottom>&nbsp;<br>
558<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
559
560<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
Joe Gregorio49396552011-03-08 10:39:00 -0500561<td width="100%"><strong>FLAGS</strong> = &lt;gflags.FlagValues instance&gt;<br>
562<strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500563<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
564<tr bgcolor="#7799ee">
565<td colspan=3 valign=bottom>&nbsp;<br>
566<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
567
568<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
569<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
570</body></html>