• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.discovery_cache.base.Cache</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        <a href="googleapiclient.discovery_cache-module.html">Package&nbsp;discovery_cache</a> ::
42        <a href="googleapiclient.discovery_cache.base-module.html">Module&nbsp;base</a> ::
43        Class&nbsp;Cache
44      </span>
45    </td>
46    <td>
47      <table cellpadding="0" cellspacing="0">
48        <!-- hide/show private -->
49        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
50    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
51        <tr><td align="right"><span class="options"
52            >[<a href="frames.html" target="_top">frames</a
53            >]&nbsp;|&nbsp;<a href="googleapiclient.discovery_cache.base.Cache-class.html"
54            target="_top">no&nbsp;frames</a>]</span></td></tr>
55      </table>
56    </td>
57  </tr>
58</table>
59<!-- ==================== CLASS DESCRIPTION ==================== -->
60<h1 class="epydoc">Class Cache</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache">source&nbsp;code</a></span></p>
61<center>
62
63</center>
64<hr />
65<pre class="literalblock">
66A base abstract cache class.
67
68</pre>
69
70<!-- ==================== INSTANCE METHODS ==================== -->
71<a name="section-InstanceMethods"></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">Instance Methods</span></td>
79        <td align="right" valign="top"
80         ><span class="options">[<a href="#section-InstanceMethods"
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      <table width="100%" cellpadding="0" cellspacing="0" border="0">
92        <tr>
93          <td><span class="summary-sig"><a href="googleapiclient.discovery_cache.base.Cache-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>,
94        <span class="summary-sig-arg">url</span>)</span><br />
95      Gets the content from the memcache with a given key.</td>
96          <td align="right" valign="top">
97            <span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache.get">source&nbsp;code</a></span>
98
99          </td>
100        </tr>
101      </table>
102
103    </td>
104  </tr>
105<tr>
106    <td width="15%" align="right" valign="top" class="summary">
107      <span class="summary-type">&nbsp;</span>
108    </td><td class="summary">
109      <table width="100%" cellpadding="0" cellspacing="0" border="0">
110        <tr>
111          <td><span class="summary-sig"><a href="googleapiclient.discovery_cache.base.Cache-class.html#set" class="summary-sig-name">set</a>(<span class="summary-sig-arg">self</span>,
112        <span class="summary-sig-arg">url</span>,
113        <span class="summary-sig-arg">content</span>)</span><br />
114      Sets the given key and content in the cache.</td>
115          <td align="right" valign="top">
116            <span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache.set">source&nbsp;code</a></span>
117
118          </td>
119        </tr>
120      </table>
121
122    </td>
123  </tr>
124  <tr>
125    <td colspan="2" class="summary">
126    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
127      <code>__delattr__</code>,
128      <code>__format__</code>,
129      <code>__getattribute__</code>,
130      <code>__hash__</code>,
131      <code>__init__</code>,
132      <code>__new__</code>,
133      <code>__reduce__</code>,
134      <code>__reduce_ex__</code>,
135      <code>__repr__</code>,
136      <code>__setattr__</code>,
137      <code>__sizeof__</code>,
138      <code>__str__</code>,
139      <code>__subclasshook__</code>
140      </p>
141    </td>
142  </tr>
143</table>
144<!-- ==================== CLASS VARIABLES ==================== -->
145<a name="section-ClassVariables"></a>
146<table class="summary" border="1" cellpadding="3"
147       cellspacing="0" width="100%" bgcolor="white">
148<tr bgcolor="#70b0f0" class="table-header">
149  <td colspan="2" class="table-header">
150    <table border="0" cellpadding="0" cellspacing="0" width="100%">
151      <tr valign="top">
152        <td align="left"><span class="table-header">Class Variables</span></td>
153        <td align="right" valign="top"
154         ><span class="options">[<a href="#section-ClassVariables"
155         class="privatelink" onclick="toggle_private();"
156         >hide private</a>]</span></td>
157      </tr>
158    </table>
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        <a name="__metaclass__"></a><span class="summary-name">__metaclass__</span> = <code title="abc.ABCMeta">abc.ABCMeta</code>
166    </td>
167  </tr>
168</table>
169<!-- ==================== PROPERTIES ==================== -->
170<a name="section-Properties"></a>
171<table class="summary" border="1" cellpadding="3"
172       cellspacing="0" width="100%" bgcolor="white">
173<tr bgcolor="#70b0f0" class="table-header">
174  <td colspan="2" class="table-header">
175    <table border="0" cellpadding="0" cellspacing="0" width="100%">
176      <tr valign="top">
177        <td align="left"><span class="table-header">Properties</span></td>
178        <td align="right" valign="top"
179         ><span class="options">[<a href="#section-Properties"
180         class="privatelink" onclick="toggle_private();"
181         >hide private</a>]</span></td>
182      </tr>
183    </table>
184  </td>
185</tr>
186  <tr>
187    <td colspan="2" class="summary">
188    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
189      <code>__class__</code>
190      </p>
191    </td>
192  </tr>
193</table>
194<!-- ==================== METHOD DETAILS ==================== -->
195<a name="section-MethodDetails"></a>
196<table class="details" border="1" cellpadding="3"
197       cellspacing="0" width="100%" bgcolor="white">
198<tr bgcolor="#70b0f0" class="table-header">
199  <td colspan="2" class="table-header">
200    <table border="0" cellpadding="0" cellspacing="0" width="100%">
201      <tr valign="top">
202        <td align="left"><span class="table-header">Method Details</span></td>
203        <td align="right" valign="top"
204         ><span class="options">[<a href="#section-MethodDetails"
205         class="privatelink" onclick="toggle_private();"
206         >hide private</a>]</span></td>
207      </tr>
208    </table>
209  </td>
210</tr>
211</table>
212<a name="get"></a>
213<div>
214<table class="details" border="1" cellpadding="3"
215       cellspacing="0" width="100%" bgcolor="white">
216<tr><td>
217  <table width="100%" cellpadding="0" cellspacing="0" border="0">
218  <tr valign="top"><td>
219  <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>,
220        <span class="sig-arg">url</span>)</span>
221  </h3>
222  </td><td align="right" valign="top"
223    ><span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache.get">source&nbsp;code</a></span>&nbsp;
224    </td>
225  </tr></table>
226
227  <pre class="literalblock">
228Gets the content from the memcache with a given key.
229
230Args:
231  url: string, the key for the cache.
232
233Returns:
234  object, the value in the cache for the given key, or None if the key is
235  not in the cache.
236
237</pre>
238  <dl class="fields">
239    <dt>Decorators:</dt>
240    <dd><ul class="nomargin-top">
241        <li><code>@abc.abstractmethod</code></li>
242    </ul></dd>
243  </dl>
244</td></tr></table>
245</div>
246<a name="set"></a>
247<div>
248<table class="details" border="1" cellpadding="3"
249       cellspacing="0" width="100%" bgcolor="white">
250<tr><td>
251  <table width="100%" cellpadding="0" cellspacing="0" border="0">
252  <tr valign="top"><td>
253  <h3 class="epydoc"><span class="sig"><span class="sig-name">set</span>(<span class="sig-arg">self</span>,
254        <span class="sig-arg">url</span>,
255        <span class="sig-arg">content</span>)</span>
256  </h3>
257  </td><td align="right" valign="top"
258    ><span class="codelink"><a href="googleapiclient.discovery_cache.base-pysrc.html#Cache.set">source&nbsp;code</a></span>&nbsp;
259    </td>
260  </tr></table>
261
262  <pre class="literalblock">
263Sets the given key and content in the cache.
264
265Args:
266  url: string, the key for the cache.
267  content: string, the discovery document.
268
269</pre>
270  <dl class="fields">
271    <dt>Decorators:</dt>
272    <dd><ul class="nomargin-top">
273        <li><code>@abc.abstractmethod</code></li>
274    </ul></dd>
275  </dl>
276</td></tr></table>
277</div>
278<br />
279<!-- ==================== NAVIGATION BAR ==================== -->
280<table class="navbar" border="0" width="100%" cellpadding="0"
281       bgcolor="#a0c0ff" cellspacing="0">
282  <tr valign="middle">
283  <!-- Home link -->
284      <th>&nbsp;&nbsp;&nbsp;<a
285        href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
286
287  <!-- Tree link -->
288      <th>&nbsp;&nbsp;&nbsp;<a
289        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
290
291  <!-- Index link -->
292      <th>&nbsp;&nbsp;&nbsp;<a
293        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
294
295  <!-- Help link -->
296      <th>&nbsp;&nbsp;&nbsp;<a
297        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
298
299      <th class="navbar" width="100%"></th>
300  </tr>
301</table>
302<table border="0" cellpadding="0" cellspacing="0" width="100%%">
303  <tr>
304    <td align="left" class="footer">
305    Generated by Epydoc 3.0.1 on Mon Jun  5 13:38:39 2017
306    </td>
307    <td align="right" class="footer">
308      <a target="mainFrame" href="http://epydoc.sourceforge.net"
309        >http://epydoc.sourceforge.net</a>
310    </td>
311  </tr>
312</table>
313
314<script type="text/javascript">
315  <!--
316  // Private objects are initially displayed (because if
317  // javascript is turned off then we want them to be
318  // visible); but by default, we want to hide them.  So hide
319  // them unless we have a cookie that says to show them.
320  checkCookie();
321  // -->
322</script>
323</body>
324</html>
325