| <?xml version="1.0" encoding="ascii"?> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | |
| "DTD/xhtml1-transitional.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | |
| <head> | |
| <title>googleapiclient.model.BaseModel</title> | |
| <link rel="stylesheet" href="epydoc.css" type="text/css" /> | |
| <script type="text/javascript" src="epydoc.js"></script> | |
| </head> | |
| <body bgcolor="white" text="black" link="blue" vlink="#204080" | |
| alink="#204080"> | |
| <!-- ==================== NAVIGATION BAR ==================== --> | |
| <table class="navbar" border="0" width="100%" cellpadding="0" | |
| bgcolor="#a0c0ff" cellspacing="0"> | |
| <tr valign="middle"> | |
| <!-- Home link --> | |
| <th> <a | |
| href="googleapiclient-module.html">Home</a> </th> | |
| <!-- Tree link --> | |
| <th> <a | |
| href="module-tree.html">Trees</a> </th> | |
| <!-- Index link --> | |
| <th> <a | |
| href="identifier-index.html">Indices</a> </th> | |
| <!-- Help link --> | |
| <th> <a | |
| href="help.html">Help</a> </th> | |
| <th class="navbar" width="100%"></th> | |
| </tr> | |
| </table> | |
| <table width="100%" cellpadding="0" cellspacing="0"> | |
| <tr valign="top"> | |
| <td width="100%"> | |
| <span class="breadcrumbs"> | |
| <a href="googleapiclient-module.html">Package googleapiclient</a> :: | |
| <a href="googleapiclient.model-module.html">Module model</a> :: | |
| Class BaseModel | |
| </span> | |
| </td> | |
| <td> | |
| <table cellpadding="0" cellspacing="0"> | |
| <!-- hide/show private --> | |
| <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" | |
| onclick="toggle_private();">hide private</a>]</span></td></tr> | |
| <tr><td align="right"><span class="options" | |
| >[<a href="frames.html" target="_top">frames</a | |
| >] | <a href="googleapiclient.model.BaseModel-class.html" | |
| target="_top">no frames</a>]</span></td></tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <!-- ==================== CLASS DESCRIPTION ==================== --> | |
| <h1 class="epydoc">Class BaseModel</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel">source code</a></span></p> | |
| <pre class="base-tree"> | |
| object --+ | |
| | | |
| <a href="googleapiclient.model.Model-class.html">Model</a> --+ | |
| | | |
| <strong class="uidshort">BaseModel</strong> | |
| </pre> | |
| <dl><dt>Known Subclasses:</dt> | |
| <dd> | |
| <ul class="subclass-list"> | |
| <li><a href="googleapiclient.model.JsonModel-class.html">JsonModel</a></li><li>, <a href="googleapiclient.model.ProtocolBufferModel-class.html">ProtocolBufferModel</a></li> </ul> | |
| </dd></dl> | |
| <hr /> | |
| <pre class="literalblock"> | |
| Base model class. | |
| Subclasses should provide implementations for the "serialize" and | |
| "deserialize" methods, as well as values for the following class attributes. | |
| Attributes: | |
| accept: The value to use for the HTTP Accept header. | |
| content_type: The value to use for the HTTP Content-type header. | |
| no_content_response: The value to return when deserializing a 204 "No | |
| Content" response. | |
| alt_param: The value to supply as the "alt" query parameter for requests. | |
| </pre> | |
| <!-- ==================== INSTANCE METHODS ==================== --> | |
| <a name="section-InstanceMethods"></a> | |
| <table class="summary" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr bgcolor="#70b0f0" class="table-header"> | |
| <td colspan="2" class="table-header"> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> | |
| <tr valign="top"> | |
| <td align="left"><span class="table-header">Instance Methods</span></td> | |
| <td align="right" valign="top" | |
| ><span class="options">[<a href="#section-InstanceMethods" | |
| class="privatelink" onclick="toggle_private();" | |
| >hide private</a>]</span></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr class="private"> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a name="_log_request"></a><span class="summary-sig-name">_log_request</span>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">headers</span>, | |
| <span class="summary-sig-arg">path_params</span>, | |
| <span class="summary-sig-arg">query</span>, | |
| <span class="summary-sig-arg">body</span>)</span><br /> | |
| Logs debugging information about the request if requested.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel._log_request">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.model.BaseModel-class.html#request" class="summary-sig-name">request</a>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">headers</span>, | |
| <span class="summary-sig-arg">path_params</span>, | |
| <span class="summary-sig-arg">query_params</span>, | |
| <span class="summary-sig-arg">body_value</span>)</span><br /> | |
| Updates outgoing requests with a serialized body.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel.request">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr class="private"> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.model.BaseModel-class.html#_build_query" class="summary-sig-name" onclick="show_private();">_build_query</a>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">params</span>)</span><br /> | |
| Builds a query string.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel._build_query">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr class="private"> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a name="_log_response"></a><span class="summary-sig-name">_log_response</span>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">resp</span>, | |
| <span class="summary-sig-arg">content</span>)</span><br /> | |
| Logs debugging information about the response if requested.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel._log_response">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.model.BaseModel-class.html#response" class="summary-sig-name">response</a>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">resp</span>, | |
| <span class="summary-sig-arg">content</span>)</span><br /> | |
| Convert the response wire format into a Python object.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel.response">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.model.BaseModel-class.html#serialize" class="summary-sig-name">serialize</a>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">body_value</span>)</span><br /> | |
| Perform the actual Python object serialization.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel.serialize">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.model.BaseModel-class.html#deserialize" class="summary-sig-name">deserialize</a>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">content</span>)</span><br /> | |
| Perform the actual deserialization from response string to Python | |
| object.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel.deserialize">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td colspan="2" class="summary"> | |
| <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: | |
| <code>__delattr__</code>, | |
| <code>__format__</code>, | |
| <code>__getattribute__</code>, | |
| <code>__hash__</code>, | |
| <code>__init__</code>, | |
| <code>__new__</code>, | |
| <code>__reduce__</code>, | |
| <code>__reduce_ex__</code>, | |
| <code>__repr__</code>, | |
| <code>__setattr__</code>, | |
| <code>__sizeof__</code>, | |
| <code>__str__</code>, | |
| <code>__subclasshook__</code> | |
| </p> | |
| </td> | |
| </tr> | |
| </table> | |
| <!-- ==================== CLASS VARIABLES ==================== --> | |
| <a name="section-ClassVariables"></a> | |
| <table class="summary" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr bgcolor="#70b0f0" class="table-header"> | |
| <td colspan="2" class="table-header"> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> | |
| <tr valign="top"> | |
| <td align="left"><span class="table-header">Class Variables</span></td> | |
| <td align="right" valign="top" | |
| ><span class="options">[<a href="#section-ClassVariables" | |
| class="privatelink" onclick="toggle_private();" | |
| >hide private</a>]</span></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <a name="accept"></a><span class="summary-name">accept</span> = <code title="None">None</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <a name="content_type"></a><span class="summary-name">content_type</span> = <code title="None">None</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <a name="no_content_response"></a><span class="summary-name">no_content_response</span> = <code title="None">None</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <a name="alt_param"></a><span class="summary-name">alt_param</span> = <code title="None">None</code> | |
| </td> | |
| </tr> | |
| </table> | |
| <!-- ==================== PROPERTIES ==================== --> | |
| <a name="section-Properties"></a> | |
| <table class="summary" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr bgcolor="#70b0f0" class="table-header"> | |
| <td colspan="2" class="table-header"> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> | |
| <tr valign="top"> | |
| <td align="left"><span class="table-header">Properties</span></td> | |
| <td align="right" valign="top" | |
| ><span class="options">[<a href="#section-Properties" | |
| class="privatelink" onclick="toggle_private();" | |
| >hide private</a>]</span></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td colspan="2" class="summary"> | |
| <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: | |
| <code>__class__</code> | |
| </p> | |
| </td> | |
| </tr> | |
| </table> | |
| <!-- ==================== METHOD DETAILS ==================== --> | |
| <a name="section-MethodDetails"></a> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr bgcolor="#70b0f0" class="table-header"> | |
| <td colspan="2" class="table-header"> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> | |
| <tr valign="top"> | |
| <td align="left"><span class="table-header">Method Details</span></td> | |
| <td align="right" valign="top" | |
| ><span class="options">[<a href="#section-MethodDetails" | |
| class="privatelink" onclick="toggle_private();" | |
| >hide private</a>]</span></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <a name="request"></a> | |
| <div> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">request</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">headers</span>, | |
| <span class="sig-arg">path_params</span>, | |
| <span class="sig-arg">query_params</span>, | |
| <span class="sig-arg">body_value</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel.request">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Updates outgoing requests with a serialized body. | |
| Args: | |
| headers: dict, request headers | |
| path_params: dict, parameters that appear in the request path | |
| query_params: dict, parameters that appear in the query | |
| body_value: object, the request body as a Python object, which must be | |
| serializable by json. | |
| Returns: | |
| A tuple of (headers, path_params, query, body) | |
| headers: dict, request headers | |
| path_params: dict, parameters that appear in the request path | |
| query: string, query part of the request URI | |
| body: string, the body serialized as JSON | |
| </pre> | |
| <dl class="fields"> | |
| <dt>Overrides: | |
| <a href="googleapiclient.model.Model-class.html#request">Model.request</a> | |
| </dt> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="_build_query"></a> | |
| <div class="private"> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">_build_query</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">params</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel._build_query">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Builds a query string. | |
| Args: | |
| params: dict, the query parameters | |
| Returns: | |
| The query parameters properly encoded into an HTTP URI query string. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="response"></a> | |
| <div> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">response</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">resp</span>, | |
| <span class="sig-arg">content</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel.response">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Convert the response wire format into a Python object. | |
| Args: | |
| resp: httplib2.Response, the HTTP response headers and status | |
| content: string, the body of the HTTP response | |
| Returns: | |
| The body de-serialized as a Python object. | |
| Raises: | |
| googleapiclient.errors.HttpError if a non 2xx response is received. | |
| </pre> | |
| <dl class="fields"> | |
| <dt>Overrides: | |
| <a href="googleapiclient.model.Model-class.html#response">Model.response</a> | |
| </dt> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="serialize"></a> | |
| <div> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">serialize</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">body_value</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel.serialize">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Perform the actual Python object serialization. | |
| Args: | |
| body_value: object, the request body as a Python object. | |
| Returns: | |
| string, the body in serialized form. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="deserialize"></a> | |
| <div> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">deserialize</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">content</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.model-pysrc.html#BaseModel.deserialize">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Perform the actual deserialization from response string to Python | |
| object. | |
| Args: | |
| content: string, the body of the HTTP response | |
| Returns: | |
| The body de-serialized as a Python object. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <br /> | |
| <!-- ==================== NAVIGATION BAR ==================== --> | |
| <table class="navbar" border="0" width="100%" cellpadding="0" | |
| bgcolor="#a0c0ff" cellspacing="0"> | |
| <tr valign="middle"> | |
| <!-- Home link --> | |
| <th> <a | |
| href="googleapiclient-module.html">Home</a> </th> | |
| <!-- Tree link --> | |
| <th> <a | |
| href="module-tree.html">Trees</a> </th> | |
| <!-- Index link --> | |
| <th> <a | |
| href="identifier-index.html">Indices</a> </th> | |
| <!-- Help link --> | |
| <th> <a | |
| href="help.html">Help</a> </th> | |
| <th class="navbar" width="100%"></th> | |
| </tr> | |
| </table> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%%"> | |
| <tr> | |
| <td align="left" class="footer"> | |
| Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020 | |
| </td> | |
| <td align="right" class="footer"> | |
| <a target="mainFrame" href="http://epydoc.sourceforge.net" | |
| >http://epydoc.sourceforge.net</a> | |
| </td> | |
| </tr> | |
| </table> | |
| <script type="text/javascript"> | |
| <!-- | |
| // Private objects are initially displayed (because if | |
| // javascript is turned off then we want them to be | |
| // visible); but by default, we want to hide them. So hide | |
| // them unless we have a cookie that says to show them. | |
| checkCookie(); | |
| // --> | |
| </script> | |
| </body> | |
| </html> |