Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5dc0f5c893f00427fe5ea7940dd5f3055ee0b726 / . / docs / epy / class-tree.html
blob: cdb16ae3af63f80249dc9b85ac6d4ff8330ca1ad [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>Class Hierarchy</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 bgcolor="#70b0f0" class="navbar-select"
20 >&nbsp;&nbsp;&nbsp;Trees&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%">&nbsp;</td>
36 <td>
37 <table cellpadding="0" cellspacing="0">
38 <!-- hide/show private -->
39 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
40 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
41 <tr><td align="right"><span class="options"
42 >[<a href="frames.html" target="_top">frames</a
43 >]&nbsp;|&nbsp;<a href="class-tree.html"
44 target="_top">no&nbsp;frames</a>]</span></td></tr>
45 </table>
46 </td>
47 </tr>
48</table>
49<center><b>
50 [ <a href="module-tree.html">Module Hierarchy</a>
51 | <a href="class-tree.html">Class Hierarchy</a> ]
52</b></center><br />
53<h1 class="epydoc">Class Hierarchy</h1>
54<ul class="nomargin-top">
55 <li> <strong class="uidlink">SocketServer.BaseRequestHandler</strong>:
56 <em class="summary">Base class for request handler classes.</em>
57 <ul>
58 <li> <strong class="uidlink">SocketServer.StreamRequestHandler</strong>:
59 <em class="summary">Define self.rfile and self.wfile for stream sockets.</em>
60 <ul>
61 <li> <strong class="uidlink">BaseHTTPServer.BaseHTTPRequestHandler</strong>:
62 <em class="summary">HTTP request handler base class.</em>
63 <ul>
64 <li> <strong class="uidlink"><a href="oauth2client.tools.ClientRedirectHandler-class.html" onclick="show_private();">oauth2client.tools.ClientRedirectHandler</a></strong>:
65 <em class="summary">A handler for OAuth 2.0 redirects back to localhost.</em>
66 </li>
67 </ul>
68 </li>
69 </ul>
70 </li>
71 </ul>
72 </li>
73 <li> <strong class="uidlink">SocketServer.BaseServer</strong>:
74 <em class="summary">Base class for server classes.</em>
75 <ul>
76 <li> <strong class="uidlink">SocketServer.TCPServer</strong>:
77 <em class="summary">Base class for various socket-based server classes.</em>
78 <ul>
79 <li> <strong class="uidlink">BaseHTTPServer.HTTPServer</strong>
80 <ul>
81 <li> <strong class="uidlink"><a href="oauth2client.tools.ClientRedirectServer-class.html" onclick="show_private();">oauth2client.tools.ClientRedirectServer</a></strong>:
82 <em class="summary">A server to handle OAuth 2.0 redirects back to localhost.</em>
83 </li>
84 </ul>
85 </li>
86 </ul>
87 </li>
88 </ul>
89 </li>
90 <li> <strong class="uidlink">rfc822.Message</strong>:
91 <em class="summary">Represents a single RFC 2822-compliant message.</em>
92 <ul>
93 <li> <strong class="uidlink"><a href="mimetools.Message-class.html">mimetools.Message</a></strong>:
94 <em class="summary">A derived class of rfc822.Message that knows about MIME headers and
95contains some hooks for decoding encoded and multipart messages.</em>
96 </li>
97 </ul>
98 </li>
99 <li> <strong class="uidlink">object</strong>:
100 <em class="summary">The most base type</em>
101 <ul>
102 <li> <strong class="uidlink">exceptions.BaseException</strong>:
103 <em class="summary">Common base class for all exceptions</em>
104 <ul>
105 <li> <strong class="uidlink">exceptions.Exception</strong>:
106 <em class="summary">Common base class for all non-exit exceptions.</em>
107 <ul>
108 <li> <strong class="uidlink"><a href="oauth2client.crypt.AppIdentityError-class.html">oauth2client.crypt.AppIdentityError</a></strong>
109 </li>
110 <li> <strong class="uidlink"><a href="oauth2client.client.Error-class.html">oauth2client.client.Error</a></strong>:
111 <em class="summary">Base error for this module.</em>
112 <ul>
113 <li> <strong class="uidlink"><a href="oauth2client.client.AccessTokenCredentialsError-class.html">oauth2client.client.AccessTokenCredentialsError</a></strong>:
114 <em class="summary">Having only the access_token means no refresh is possible.</em>
115 </li>
116 <li> <strong class="uidlink"><a href="oauth2client.client.AccessTokenRefreshError-class.html">oauth2client.client.AccessTokenRefreshError</a></strong>:
117 <em class="summary">Error trying to refresh an expired access token.</em>
118 </li>
119 <li> <strong class="uidlink"><a href="oauth2client.client.FlowExchangeError-class.html">oauth2client.client.FlowExchangeError</a></strong>:
120 <em class="summary">Error trying to exchange an authorization grant for an access token.</em>
121 </li>
122 <li> <strong class="uidlink"><a href="oauth2client.client.UnknownClientSecretsFlowError-class.html">oauth2client.client.UnknownClientSecretsFlowError</a></strong>:
123 <em class="summary">The client secrets file called for an unknown type of OAuth 2.0 flow.</em>
124 </li>
125 <li> <strong class="uidlink"><a href="oauth2client.client.VerifyJwtTokenError-class.html">oauth2client.client.VerifyJwtTokenError</a></strong>:
126 <em class="summary">Could on retrieve certificates for validation.</em>
127 </li>
128 </ul>
129 </li>
130 <li> <strong class="uidlink"><a href="oauth2client.clientsecrets.Error-class.html">oauth2client.clientsecrets.Error</a></strong>:
131 <em class="summary">Base error for this module.</em>
132 <ul>
133 <li> <strong class="uidlink"><a href="oauth2client.clientsecrets.InvalidClientSecretsError-class.html">oauth2client.clientsecrets.InvalidClientSecretsError</a></strong>:
134 <em class="summary">Format of ClientSecrets file is invalid.</em>
135 </li>
136 </ul>
137 </li>
138 <li> <strong class="uidlink"><a href="oauth2client.multistore_file.Error-class.html">oauth2client.multistore_file.Error</a></strong>:
139 <em class="summary">Base error for this module.</em>
140 <ul>
141 <li> <strong class="uidlink"><a href="oauth2client.multistore_file.NewerCredentialStoreError-class.html">oauth2client.multistore_file.NewerCredentialStoreError</a></strong>:
142 <em class="summary">The credential store is a newer version that supported.</em>
143 </li>
144 </ul>
145 </li>
146 <li> <strong class="uidlink"><a href="apiclient.errors.Error-class.html">apiclient.errors.Error</a></strong>:
147 <em class="summary">Base error for this module.</em>
148 <ul>
149 <li> <strong class="uidlink"><a href="apiclient.errors.HttpError-class.html">apiclient.errors.HttpError</a></strong>:
150 <em class="summary">HTTP data was invalid or unexpected.</em>
151 <ul>
152 <li> <strong class="uidlink"><a href="apiclient.errors.BatchError-class.html">apiclient.errors.BatchError</a></strong>:
153 <em class="summary">Error occured during batch operations.</em>
154 </li>
155 </ul>
156 </li>
157 <li> <strong class="uidlink"><a href="apiclient.errors.InvalidJsonError-class.html">apiclient.errors.InvalidJsonError</a></strong>:
158 <em class="summary">The JSON returned could not be parsed.</em>
159 </li>
160 <li> <strong class="uidlink"><a href="apiclient.errors.MediaUploadSizeError-class.html">apiclient.errors.MediaUploadSizeError</a></strong>:
161 <em class="summary">Media is larger than the method can accept.</em>
162 </li>
163 <li> <strong class="uidlink"><a href="apiclient.errors.ResumableUploadError-class.html">apiclient.errors.ResumableUploadError</a></strong>:
164 <em class="summary">Error occured during resumable upload.</em>
165 </li>
166 <li> <strong class="uidlink"><a href="apiclient.errors.UnacceptableMimeTypeError-class.html">apiclient.errors.UnacceptableMimeTypeError</a></strong>:
167 <em class="summary">That is an unacceptable mimetype for this operation.</em>
168 </li>
169 <li> <strong class="uidlink"><a href="apiclient.errors.UnexpectedBodyError-class.html">apiclient.errors.UnexpectedBodyError</a></strong>:
170 <em class="summary">Exception raised by RequestMockBuilder on unexpected bodies.</em>
171 </li>
172 <li> <strong class="uidlink"><a href="apiclient.errors.UnexpectedMethodError-class.html">apiclient.errors.UnexpectedMethodError</a></strong>:
173 <em class="summary">Exception raised by RequestMockBuilder on unexpected calls.</em>
174 </li>
175 <li> <strong class="uidlink"><a href="apiclient.errors.UnknownApiNameOrVersion-class.html">apiclient.errors.UnknownApiNameOrVersion</a></strong>:
176 <em class="summary">No API with that name and version exists.</em>
177 </li>
178 <li> <strong class="uidlink"><a href="apiclient.errors.UnknownLinkType-class.html">apiclient.errors.UnknownLinkType</a></strong>:
179 <em class="summary">Link type unknown or unexpected.</em>
180 </li>
181 </ul>
182 </li>
183 <li> <strong class="uidlink"><a href="oauth2client.appengine.InvalidClientSecretsError-class.html">oauth2client.appengine.InvalidClientSecretsError</a></strong>:
184 <em class="summary">The client_secrets.json file is malformed or missing required fields.</em>
185 </li>
186 </ul>
187 </li>
188 </ul>
189 </li>
190 <li> <strong class="uidlink"><a href="apiclient.http.BatchHttpRequest-class.html">apiclient.http.BatchHttpRequest</a></strong>:
191 <em class="summary">Batches multiple HttpRequest objects into a single HTTP request.</em>
192 </li>
193 <li> <strong class="uidlink"><a href="oauth2client.client.Credentials-class.html">oauth2client.client.Credentials</a></strong>:
194 <em class="summary">Base class for all Credentials objects.</em>
195 <ul>
196 <li> <strong class="uidlink"><a href="oauth2client.client.OAuth2Credentials-class.html">oauth2client.client.OAuth2Credentials</a></strong>:
197 <em class="summary">Credentials object for OAuth 2.0.</em>
198 <ul>
199 <li> <strong class="uidlink"><a href="oauth2client.client.AccessTokenCredentials-class.html">oauth2client.client.AccessTokenCredentials</a></strong>:
200 <em class="summary">Credentials object for OAuth 2.0.</em>
201 </li>
202 <li> <strong class="uidlink"><a href="oauth2client.client.AssertionCredentials-class.html">oauth2client.client.AssertionCredentials</a></strong>:
203 <em class="summary">Abstract Credentials object used for OAuth 2.0 assertion grants.</em>
204 <ul>
205 <li> <strong class="uidlink"><a href="oauth2client.appengine.AppAssertionCredentials-class.html">oauth2client.appengine.AppAssertionCredentials</a></strong>:
206 <em class="summary">Credentials object for App Engine Assertion Grants</em>
207 </li>
208 <li> <strong class="uidlink"><a href="oauth2client.client.SignedJwtAssertionCredentials-class.html">oauth2client.client.SignedJwtAssertionCredentials</a></strong>:
209 <em class="summary">Credentials object used for OAuth 2.0 Signed JWT assertion grants.</em>
210 </li>
211 </ul>
212 </li>
213 </ul>
214 </li>
215 </ul>
216 </li>
217 <li> <strong class="uidlink">django.db.models.fields.Field</strong>:
218 <em class="summary">Base class for all field types</em>
219 <ul>
220 <li> <strong class="uidlink"><a href="oauth2client.django_orm.CredentialsField-class.html">oauth2client.django_orm.CredentialsField</a></strong>
221 </li>
222 <li> <strong class="uidlink"><a href="oauth2client.django_orm.FlowField-class.html">oauth2client.django_orm.FlowField</a></strong>
223 </li>
224 </ul>
225 </li>
226 <li> <strong class="uidlink"><a href="oauth2client.client.Flow-class.html">oauth2client.client.Flow</a></strong>:
227 <em class="summary">Base class for all Flow objects.</em>
228 <ul>
229 <li> <strong class="uidlink"><a href="oauth2client.client.OAuth2WebServerFlow-class.html">oauth2client.client.OAuth2WebServerFlow</a></strong>:
230 <em class="summary">Does the Web Server Flow for OAuth 2.0.</em>
231 </li>
232 </ul>
233 </li>
234 <li> <strong class="uidlink"><a href="apiclient.http.HttpMock-class.html">apiclient.http.HttpMock</a></strong>:
235 <em class="summary">Mock of httplib2.Http</em>
236 </li>
237 <li> <strong class="uidlink"><a href="apiclient.http.HttpMockSequence-class.html">apiclient.http.HttpMockSequence</a></strong>:
238 <em class="summary">Mock of httplib2.Http</em>
239 </li>
240 <li> <strong class="uidlink"><a href="apiclient.http.HttpRequest-class.html">apiclient.http.HttpRequest</a></strong>:
241 <em class="summary">Encapsulates a single HTTP request.</em>
242 </li>
243 <li> <strong class="uidlink"><a href="apiclient.http.HttpRequestMock-class.html">apiclient.http.HttpRequestMock</a></strong>:
244 <em class="summary">Mock of HttpRequest.</em>
245 </li>
246 <li> <strong class="uidlink"><a href="apiclient.http.MediaUpload-class.html">apiclient.http.MediaUpload</a></strong>:
247 <em class="summary">Describes a media object to upload.</em>
248 <ul>
249 <li> <strong class="uidlink"><a href="apiclient.http.MediaFileUpload-class.html">apiclient.http.MediaFileUpload</a></strong>:
250 <em class="summary">A MediaUpload for a file.</em>
251 </li>
252 <li> <strong class="uidlink"><a href="apiclient.http.MediaInMemoryUpload-class.html">apiclient.http.MediaInMemoryUpload</a></strong>:
253 <em class="summary">MediaUpload for a chunk of bytes.</em>
254 </li>
255 </ul>
256 </li>
257 <li> <strong class="uidlink"><a href="apiclient.http.MediaUploadProgress-class.html">apiclient.http.MediaUploadProgress</a></strong>:
258 <em class="summary">Status of a resumable upload.</em>
259 </li>
260 <li> <strong class="uidlink"><a href="oauth2client.client.MemoryCache-class.html">oauth2client.client.MemoryCache</a></strong>:
261 <em class="summary">httplib2 Cache implementation which only caches locally.</em>
262 </li>
263 <li> <strong class="uidlink">google.appengine.ext.db.Model</strong>:
264 <em class="summary">Model is the superclass of all object entities in the datastore.</em>
265 <ul>
266 <li> <strong class="uidlink"><a href="oauth2client.appengine.CredentialsModel-class.html">oauth2client.appengine.CredentialsModel</a></strong>:
267 <em class="summary">Storage for OAuth 2.0 Credentials</em>
268 </li>
269 </ul>
270 </li>
271 <li> <strong class="uidlink"><a href="apiclient.model.Model-class.html">apiclient.model.Model</a></strong>:
272 <em class="summary">Model base class.</em>
273 <ul>
274 <li> <strong class="uidlink"><a href="apiclient.model.BaseModel-class.html">apiclient.model.BaseModel</a></strong>:
275 <em class="summary">Base model class.</em>
276 <ul>
277 <li> <strong class="uidlink"><a href="apiclient.model.JsonModel-class.html">apiclient.model.JsonModel</a></strong>:
278 <em class="summary">Model class for JSON.</em>
279 <ul>
280 <li> <strong class="uidlink"><a href="apiclient.model.RawModel-class.html">apiclient.model.RawModel</a></strong>:
281 <em class="summary">Model class for requests that don't return JSON.</em>
282 </li>
283 </ul>
284 </li>
285 <li> <strong class="uidlink"><a href="apiclient.model.ProtocolBufferModel-class.html">apiclient.model.ProtocolBufferModel</a></strong>:
286 <em class="summary">Model class for protocol buffers.</em>
287 </li>
288 </ul>
289 </li>
290 </ul>
291 </li>
292 <li> <strong class="uidlink"><a href="oauth2client.appengine.OAuth2Decorator-class.html">oauth2client.appengine.OAuth2Decorator</a></strong>:
293 <em class="summary">Utility for making OAuth 2.0 easier.</em>
294 <ul>
295 <li> <strong class="uidlink"><a href="oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html">oauth2client.appengine.OAuth2DecoratorFromClientSecrets</a></strong>:
296 <em class="summary">An OAuth2Decorator that builds from a clientsecrets file.</em>
297 </li>
298 </ul>
299 </li>
300 <li> <strong class="uidlink">google.appengine.ext.db.Property</strong>:
301 <em class="summary">A Property is an attribute of a Model.</em>
302 <ul>
303 <li> <strong class="uidlink"><a href="oauth2client.appengine.CredentialsProperty-class.html">oauth2client.appengine.CredentialsProperty</a></strong>:
304 <em class="summary">App Engine datastore Property for Credentials.</em>
305 </li>
306 <li> <strong class="uidlink"><a href="oauth2client.appengine.FlowProperty-class.html">oauth2client.appengine.FlowProperty</a></strong>:
307 <em class="summary">App Engine datastore Property for Flow.</em>
308 </li>
309 </ul>
310 </li>
311 <li> <strong class="uidlink">google.appengine.ext.webapp._webapp25.RequestHandler</strong>:
312 <em class="summary">Our base HTTP request handler.</em>
313 <ul>
314 <li> <strong class="uidlink"><a href="oauth2client.appengine.OAuth2Handler-class.html">oauth2client.appengine.OAuth2Handler</a></strong>:
315 <em class="summary">Handler for the redirect_uri of the OAuth 2.0 dance.</em>
316 </li>
317 </ul>
318 </li>
319 <li> <strong class="uidlink"><a href="apiclient.http.RequestMockBuilder-class.html">apiclient.http.RequestMockBuilder</a></strong>:
320 <em class="summary">A simple mock of HttpRequest</em>
321 </li>
322 <li> <strong class="uidlink"><a href="apiclient.schema.Schemas-class.html">apiclient.schema.Schemas</a></strong>:
323 <em class="summary">Schemas for an API.</em>
324 </li>
325 <li> <strong class="uidlink"><a href="oauth2client.crypt.Signer-class.html">oauth2client.crypt.Signer</a></strong>:
326 <em class="summary">Signs messages with a private key.</em>
327 </li>
328 <li> <strong class="uidlink"><a href="oauth2client.client.Storage-class.html">oauth2client.client.Storage</a></strong>:
329 <em class="summary">Base class for all Storage objects.</em>
330 <ul>
331 <li> <strong class="uidlink"><a href="oauth2client.file.Storage-class.html">oauth2client.file.Storage</a></strong>:
332 <em class="summary">Store and retrieve a single credential to and from a file.</em>
333 </li>
334 <li> <strong class="uidlink"><a href="oauth2client.django_orm.Storage-class.html">oauth2client.django_orm.Storage</a></strong>:
335 <em class="summary">Store and retrieve a single credential to and from
336the datastore.</em>
337 </li>
338 <li> <strong class="uidlink"><a href="oauth2client.appengine.StorageByKeyName-class.html">oauth2client.appengine.StorageByKeyName</a></strong>:
339 <em class="summary">Store and retrieve a single credential to and from
340the App Engine datastore.</em>
341 </li>
342 <li> <strong class="uidlink"><a href="oauth2client.multistore_file._MultiStore._Storage-class.html" onclick="show_private();">oauth2client.multistore_file._MultiStore._Storage</a></strong>:
343 <em class="summary">A Storage object that knows how to read/write a single credential.</em>
344 </li>
345 </ul>
346 </li>
347 <li> <strong class="uidlink"><a href="oauth2client.crypt.Verifier-class.html">oauth2client.crypt.Verifier</a></strong>:
348 <em class="summary">Verifies the signature on a message.</em>
349 </li>
350 <li> <strong class="uidlink"><a href="oauth2client.multistore_file._MultiStore-class.html" onclick="show_private();">oauth2client.multistore_file._MultiStore</a></strong>:
351 <em class="summary">A file backed store for multiple credentials.</em>
352 </li>
353 <li> <strong class="uidlink"><a href="apiclient.schema._SchemaToStruct-class.html" onclick="show_private();">apiclient.schema._SchemaToStruct</a></strong>:
354 <em class="summary">Convert schema to a prototype object.</em>
355 </li>
356 <li> <strong class="uidlink">type</strong>:
357 <em class="summary">type(object) -&gt; the object's type...</em>
358 <ul>
359 <li> <strong class="uidlink"><a href="google.appengine.ext.db.PropertiedClass-class.html">google.appengine.ext.db.PropertiedClass</a></strong>:
360 <em class="summary">Meta-class for initializing Model classes properties.</em>
361 </li>
362 <li> <strong class="uidlink"><a href="django.db.models.fields.subclassing.SubfieldBase-class.html">django.db.models.fields.subclassing.SubfieldBase</a></strong>:
363 <em class="summary">A metaclass for custom Field subclasses.</em>
364 </li>
365 </ul>
366 </li>
367 </ul>
368 </li>
369</ul>
370<!-- ==================== NAVIGATION BAR ==================== -->
371<table class="navbar" border="0" width="100%" cellpadding="0"
372 bgcolor="#a0c0ff" cellspacing="0">
373 <tr valign="middle">
374
375 <!-- Tree link -->
376 <th bgcolor="#70b0f0" class="navbar-select"
377 >&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>
378
379 <!-- Index link -->
380 <th>&nbsp;&nbsp;&nbsp;<a
381 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
382
383 <!-- Help link -->
384 <th>&nbsp;&nbsp;&nbsp;<a
385 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
386
387 <th class="navbar" width="100%"></th>
388 </tr>
389</table>
390<table border="0" cellpadding="0" cellspacing="0" width="100%%">
391 <tr>
392 <td align="left" class="footer">
393 Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:04 2012
394 </td>
395 <td align="right" class="footer">
396 <a target="mainFrame" href="http://epydoc.sourceforge.net"
397 >http://epydoc.sourceforge.net</a>
398 </td>
399 </tr>
400</table>
401
402<script type="text/javascript">
403 <!--
404 // Private objects are initially displayed (because if
405 // javascript is turned off then we want them to be
406 // visible); but by default, we want to hide them. So hide
407 // them unless we have a cookie that says to show them.
408 checkCookie();
409 // -->
410</script>
411</body>
412</html>