Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / afdf50bd1b04c869e100307dc17bed699b7c0a36 / . / docs / apiclient.errors.html
blob: f439bc01ce205c64c889cecf81acab2625e41d7c [file] [log] [blame]
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module apiclient.errors</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>.errors</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500[diff] [blame]11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/apiary/apiclient/errors.py">/home/jcgregorio/projects/apiary/apiclient/errors.py</a></font></td></tr></table>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]12 <p><tt>Errors&nbsp;for&nbsp;the&nbsp;library.<br>
13&nbsp;<br>
14All&nbsp;exceptions&nbsp;defined&nbsp;by&nbsp;the&nbsp;library<br>
15should&nbsp;be&nbsp;defined&nbsp;in&nbsp;this&nbsp;file.</tt></p>
16<p>
17<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]18<tr bgcolor="#aa55cc">
19<td colspan=3 valign=bottom>&nbsp;<br>
20<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
21
22<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
23<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="simplejson.html">simplejson</a><br>
24</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
25<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]26<tr bgcolor="#ee77aa">
27<td colspan=3 valign=bottom>&nbsp;<br>
28<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
29
30<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
31<td width="100%"><dl>
32<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
33</font></dt><dd>
34<dl>
35<dt><font face="helvetica, arial"><a href="apiclient.errors.html#Error">Error</a>
36</font></dt><dd>
37<dl>
38<dt><font face="helvetica, arial"><a href="apiclient.errors.html#HttpError">HttpError</a>
39</font></dt><dt><font face="helvetica, arial"><a href="apiclient.errors.html#UnknownLinkType">UnknownLinkType</a>
40</font></dt></dl>
41</dd>
42</dl>
43</dd>
44</dl>
45 <p>
46<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
47<tr bgcolor="#ffc8d8">
48<td colspan=3 valign=bottom>&nbsp;<br>
49<font color="#000000" face="helvetica, arial"><a name="Error">class <strong>Error</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
50
51<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
52<td colspan=2><tt>Base&nbsp;error&nbsp;for&nbsp;this&nbsp;module.<br>&nbsp;</tt></td></tr>
53<tr><td>&nbsp;</td>
54<td width="100%"><dl><dt>Method resolution order:</dt>
55<dd><a href="apiclient.errors.html#Error">Error</a></dd>
56<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
57<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
58<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
59</dl>
60<hr>
61Data descriptors defined here:<br>
62<dl><dt><strong>__weakref__</strong></dt>
63<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
64</dl>
65<hr>
66Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
67<dl><dt><a name="Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
68
69<hr>
70Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
71<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#Error-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
72
73<hr>
74Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
75<dl><dt><a name="Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
76
77<dl><dt><a name="Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
78
79<dl><dt><a name="Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
80
81<dl><dt><a name="Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
82&nbsp;<br>
83Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
84
85<dl><dt><a name="Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
86
87<dl><dt><a name="Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
88
89<dl><dt><a name="Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
90
91<dl><dt><a name="Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
92
93<dl><dt><a name="Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
94
95<dl><dt><a name="Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
96
97<hr>
98Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
99<dl><dt><strong>__dict__</strong></dt>
100</dl>
101<dl><dt><strong>args</strong></dt>
102</dl>
103<dl><dt><strong>message</strong></dt>
104</dl>
105</td></tr></table> <p>
106<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
107<tr bgcolor="#ffc8d8">
108<td colspan=3 valign=bottom>&nbsp;<br>
109<font color="#000000" face="helvetica, arial"><a name="HttpError">class <strong>HttpError</strong></a>(<a href="apiclient.errors.html#Error">Error</a>)</font></td></tr>
110
111<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
112<td colspan=2><tt>HTTP&nbsp;data&nbsp;was&nbsp;invalid&nbsp;or&nbsp;unexpected.<br>&nbsp;</tt></td></tr>
113<tr><td>&nbsp;</td>
114<td width="100%"><dl><dt>Method resolution order:</dt>
115<dd><a href="apiclient.errors.html#HttpError">HttpError</a></dd>
116<dd><a href="apiclient.errors.html#Error">Error</a></dd>
117<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
118<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
119<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
120</dl>
121<hr>
122Methods defined here:<br>
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]123<dl><dt><a name="HttpError-__init__"><strong>__init__</strong></a>(self, resp, content)</dt></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]124
Joe Gregorio6e537032011-02-09 23:04:26 -0500[diff] [blame]125<dl><dt><a name="HttpError-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>
126
127<dl><dt><a name="HttpError-__str__"><strong>__str__</strong></a> = <a href="#HttpError-__repr__">__repr__</a>(self)</dt></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]128
129<hr>
130Data descriptors inherited from <a href="apiclient.errors.html#Error">Error</a>:<br>
131<dl><dt><strong>__weakref__</strong></dt>
132<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
133</dl>
134<hr>
135Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
136<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#HttpError-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
137
138<hr>
139Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
140<dl><dt><a name="HttpError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
141
142<dl><dt><a name="HttpError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
143
144<dl><dt><a name="HttpError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
145
146<dl><dt><a name="HttpError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
147&nbsp;<br>
148Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
149
150<dl><dt><a name="HttpError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
151
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500[diff] [blame]152<dl><dt><a name="HttpError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
153
154<dl><dt><a name="HttpError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
155
156<dl><dt><a name="HttpError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
157
158<hr>
159Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
160<dl><dt><strong>__dict__</strong></dt>
161</dl>
162<dl><dt><strong>args</strong></dt>
163</dl>
164<dl><dt><strong>message</strong></dt>
165</dl>
166</td></tr></table> <p>
167<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
168<tr bgcolor="#ffc8d8">
169<td colspan=3 valign=bottom>&nbsp;<br>
170<font color="#000000" face="helvetica, arial"><a name="UnknownLinkType">class <strong>UnknownLinkType</strong></a>(<a href="apiclient.errors.html#Error">Error</a>)</font></td></tr>
171
172<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
173<td colspan=2><tt>Link&nbsp;type&nbsp;unknown&nbsp;or&nbsp;unexpected.<br>&nbsp;</tt></td></tr>
174<tr><td>&nbsp;</td>
175<td width="100%"><dl><dt>Method resolution order:</dt>
176<dd><a href="apiclient.errors.html#UnknownLinkType">UnknownLinkType</a></dd>
177<dd><a href="apiclient.errors.html#Error">Error</a></dd>
178<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
179<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
180<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
181</dl>
182<hr>
183Data descriptors inherited from <a href="apiclient.errors.html#Error">Error</a>:<br>
184<dl><dt><strong>__weakref__</strong></dt>
185<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
186</dl>
187<hr>
188Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
189<dl><dt><a name="UnknownLinkType-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
190
191<hr>
192Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
193<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#UnknownLinkType-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
194
195<hr>
196Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
197<dl><dt><a name="UnknownLinkType-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
198
199<dl><dt><a name="UnknownLinkType-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
200
201<dl><dt><a name="UnknownLinkType-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
202
203<dl><dt><a name="UnknownLinkType-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
204&nbsp;<br>
205Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
206
207<dl><dt><a name="UnknownLinkType-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
208
209<dl><dt><a name="UnknownLinkType-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
210
211<dl><dt><a name="UnknownLinkType-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
212
213<dl><dt><a name="UnknownLinkType-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
214
215<dl><dt><a name="UnknownLinkType-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
216
217<dl><dt><a name="UnknownLinkType-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
218
219<hr>
220Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
221<dl><dt><strong>__dict__</strong></dt>
222</dl>
223<dl><dt><strong>args</strong></dt>
224</dl>
225<dl><dt><strong>message</strong></dt>
226</dl>
227</td></tr></table></td></tr></table><p>
228<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
229<tr bgcolor="#55aa55">
230<td colspan=3 valign=bottom>&nbsp;<br>
231<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
232
233<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
234<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
235<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
236<tr bgcolor="#7799ee">
237<td colspan=3 valign=bottom>&nbsp;<br>
238<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
239
240<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
241<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
242</body></html>