Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c211bec621911c2d3b448c7e1e5a39cf36f14b3b / . / docs / epy / oauth2client.gce.AppAssertionCredentials-class.html
blob: 94e348a601e40c077556a64ceb2d3ed3235a66b8 [file] [log] [blame]
Joe Gregorio1b425aa2012-08-24 12:04:34 -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>oauth2client.gce.AppAssertionCredentials</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>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&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%">
36 <span class="breadcrumbs">
37 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 <a href="oauth2client.gce-module.html">Module&nbsp;gce</a> ::
39 Class&nbsp;AppAssertionCredentials
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="oauth2client.gce.AppAssertionCredentials-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class AppAssertionCredentials</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.gce-pysrc.html#AppAssertionCredentials">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="class_hierarchy_for_appasserti_2" name="class_hierarchy_for_appasserti_2">
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]59<area shape="rect" id="node1" href="oauth2client.client.AssertionCredentials-class.html" title="client.AssertionCredentials" alt="" coords="5,6,184,34"/>
60<area shape="rect" id="node2" href="oauth2client.client.Credentials-class.html" title="client.Credentials" alt="" coords="208,6,331,34"/>
61<area shape="rect" id="node3" href="oauth2client.client.OAuth2Credentials-class.html" title="client.OAuth2Credentials" alt="" coords="355,6,520,34"/>
62<area shape="rect" id="node4" href="oauth2client.gce.AppAssertionCredentials-class.html" title="AppAssertionCredentials" alt="" coords="544,6,709,34"/>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]63</map>
64 <img src="class_hierarchy_for_appasserti_2.gif" alt='' usemap="#class_hierarchy_for_appasserti_2" ismap="ismap" class="graph-without-title" />
65</center>
66</center>
67<hr />
68<pre class="literalblock">
69Credentials object for Compute Engine Assertion Grants
70
71This object will allow a Compute Engine instance to identify itself to
72Google and other OAuth 2.0 servers that can verify assertions. It can be used
73for the purpose of accessing data stored under an account assigned to the
74Compute Engine instance itself.
75
76This credential does not require a flow to instantiate because it represents
77a two legged flow, and therefore has all of the required information to
78generate and refresh its own access tokens.
79
80</pre>
81
82<!-- ==================== INSTANCE METHODS ==================== -->
83<a name="section-InstanceMethods"></a>
84<table class="summary" border="1" cellpadding="3"
85 cellspacing="0" width="100%" bgcolor="white">
86<tr bgcolor="#70b0f0" class="table-header">
87 <td colspan="2" class="table-header">
88 <table border="0" cellpadding="0" cellspacing="0" width="100%">
89 <tr valign="top">
90 <td align="left"><span class="table-header">Instance Methods</span></td>
91 <td align="right" valign="top"
92 ><span class="options">[<a href="#section-InstanceMethods"
93 class="privatelink" onclick="toggle_private();"
94 >hide private</a>]</span></td>
95 </tr>
96 </table>
97 </td>
98</tr>
99<tr>
100 <td width="15%" align="right" valign="top" class="summary">
101 <span class="summary-type">&nbsp;</span>
102 </td><td class="summary">
103 <table width="100%" cellpadding="0" cellspacing="0" border="0">
104 <tr>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]105 <td><span class="summary-sig"><a href="oauth2client.gce.AppAssertionCredentials-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
106 <span class="summary-sig-arg">scope</span>,
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]107 <span class="summary-sig-arg">**kwargs</span>)</span><br />
108 Constructor for AppAssertionCredentials</td>
109 <td align="right" valign="top">
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]110 <span class="codelink"><a href="oauth2client.gce-pysrc.html#AppAssertionCredentials.__init__">source&nbsp;code</a></span>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]111
112 </td>
113 </tr>
114 </table>
115
116 </td>
117 </tr>
118<tr class="private">
119 <td width="15%" align="right" valign="top" class="summary">
120 <span class="summary-type">&nbsp;</span>
121 </td><td class="summary">
122 <table width="100%" cellpadding="0" cellspacing="0" border="0">
123 <tr>
124 <td><span class="summary-sig"><a href="oauth2client.gce.AppAssertionCredentials-class.html#_refresh" class="summary-sig-name" onclick="show_private();">_refresh</a>(<span class="summary-sig-arg">self</span>,
125 <span class="summary-sig-arg">http_request</span>)</span><br />
126 Refreshes the access_token.</td>
127 <td align="right" valign="top">
128 <span class="codelink"><a href="oauth2client.gce-pysrc.html#AppAssertionCredentials._refresh">source&nbsp;code</a></span>
129
130 </td>
131 </tr>
132 </table>
133
134 </td>
135 </tr>
136 <tr>
137 <td colspan="2" class="summary">
138 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.AssertionCredentials-class.html">client.AssertionCredentials</a></code></b> (private):
139 <code><a href="oauth2client.client.AssertionCredentials-class.html#_generate_assertion" onclick="show_private();">_generate_assertion</a></code>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]140 <code><a href="oauth2client.client.AssertionCredentials-class.html#_generate_refresh_request_body" onclick="show_private();">_generate_refresh_request_body</a></code>,
141 <code><a href="oauth2client.client.AssertionCredentials-class.html#_revoke" onclick="show_private();">_revoke</a></code>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]142 </p></div>
143 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">client.OAuth2Credentials</a></code></b>:
144 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__getstate__">__getstate__</a></code>,
145 <code><a href="oauth2client.client.OAuth2Credentials-class.html#__setstate__">__setstate__</a></code>,
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]146 <code><a href="oauth2client.client.OAuth2Credentials-class.html#access_token_expired">access_token_expired</a></code>,
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]147 <code><a href="oauth2client.client.OAuth2Credentials-class.html#apply">apply</a></code>,
148 <code><a href="oauth2client.client.OAuth2Credentials-class.html#authorize">authorize</a></code>,
149 <code><a href="oauth2client.client.OAuth2Credentials-class.html#refresh">refresh</a></code>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]150 <code><a href="oauth2client.client.OAuth2Credentials-class.html#revoke">revoke</a></code>,
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]151 <code><a href="oauth2client.client.OAuth2Credentials-class.html#set_store">set_store</a></code>,
152 <code><a href="oauth2client.client.OAuth2Credentials-class.html#to_json">to_json</a></code>
153 </p>
154 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.OAuth2Credentials-class.html">client.OAuth2Credentials</a></code></b> (private):
155 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_refresh_request" onclick="show_private();">_do_refresh_request</a></code>,
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]156 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_do_revoke" onclick="show_private();">_do_revoke</a></code>,
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]157 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_generate_refresh_request_headers" onclick="show_private();">_generate_refresh_request_headers</a></code>,
158 <code><a href="oauth2client.client.OAuth2Credentials-class.html#_updateFromCredential" onclick="show_private();">_updateFromCredential</a></code>
159 </p></div>
160 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">client.Credentials</a></code></b> (private):
161 <code><a href="oauth2client.client.Credentials-class.html#_to_json" onclick="show_private();">_to_json</a></code>
162 </p></div>
163 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
164 <code>__delattr__</code>,
165 <code>__format__</code>,
166 <code>__getattribute__</code>,
167 <code>__hash__</code>,
168 <code>__new__</code>,
169 <code>__reduce__</code>,
170 <code>__reduce_ex__</code>,
171 <code>__repr__</code>,
172 <code>__setattr__</code>,
173 <code>__sizeof__</code>,
174 <code>__str__</code>,
175 <code>__subclasshook__</code>
176 </p>
177 </td>
178 </tr>
179</table>
180<!-- ==================== CLASS METHODS ==================== -->
181<a name="section-ClassMethods"></a>
182<table class="summary" border="1" cellpadding="3"
183 cellspacing="0" width="100%" bgcolor="white">
184<tr bgcolor="#70b0f0" class="table-header">
185 <td colspan="2" class="table-header">
186 <table border="0" cellpadding="0" cellspacing="0" width="100%">
187 <tr valign="top">
188 <td align="left"><span class="table-header">Class Methods</span></td>
189 <td align="right" valign="top"
190 ><span class="options">[<a href="#section-ClassMethods"
191 class="privatelink" onclick="toggle_private();"
192 >hide private</a>]</span></td>
193 </tr>
194 </table>
195 </td>
196</tr>
197<tr>
198 <td width="15%" align="right" valign="top" class="summary">
199 <span class="summary-type">&nbsp;</span>
200 </td><td class="summary">
201 <table width="100%" cellpadding="0" cellspacing="0" border="0">
202 <tr>
203 <td><span class="summary-sig"><a href="oauth2client.gce.AppAssertionCredentials-class.html#from_json" class="summary-sig-name">from_json</a>(<span class="summary-sig-arg">cls</span>,
204 <span class="summary-sig-arg">json</span>)</span><br />
205 Instantiate a Credentials object from a JSON description of it.</td>
206 <td align="right" valign="top">
207 <span class="codelink"><a href="oauth2client.gce-pysrc.html#AppAssertionCredentials.from_json">source&nbsp;code</a></span>
208
209 </td>
210 </tr>
211 </table>
212
213 </td>
214 </tr>
215 <tr>
216 <td colspan="2" class="summary">
217 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">client.Credentials</a></code></b>:
218 <code><a href="oauth2client.client.Credentials-class.html#new_from_json">new_from_json</a></code>
219 </p>
220 </td>
221 </tr>
222</table>
223<!-- ==================== CLASS VARIABLES ==================== -->
224<a name="section-ClassVariables"></a>
225<table class="summary" border="1" cellpadding="3"
226 cellspacing="0" width="100%" bgcolor="white">
227<tr bgcolor="#70b0f0" class="table-header">
228 <td colspan="2" class="table-header">
229 <table border="0" cellpadding="0" cellspacing="0" width="100%">
230 <tr valign="top">
231 <td align="left"><span class="table-header">Class Variables</span></td>
232 <td align="right" valign="top"
233 ><span class="options">[<a href="#section-ClassVariables"
234 class="privatelink" onclick="toggle_private();"
235 >hide private</a>]</span></td>
236 </tr>
237 </table>
238 </td>
239</tr>
240 <tr>
241 <td colspan="2" class="summary">
242 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="oauth2client.client.Credentials-class.html">client.Credentials</a></code></b>:
243 <code><a href="oauth2client.client.Credentials-class.html#NON_SERIALIZED_MEMBERS">NON_SERIALIZED_MEMBERS</a></code>
244 </p>
245 </td>
246 </tr>
247</table>
248<!-- ==================== PROPERTIES ==================== -->
249<a name="section-Properties"></a>
250<table class="summary" border="1" cellpadding="3"
251 cellspacing="0" width="100%" bgcolor="white">
252<tr bgcolor="#70b0f0" class="table-header">
253 <td colspan="2" class="table-header">
254 <table border="0" cellpadding="0" cellspacing="0" width="100%">
255 <tr valign="top">
256 <td align="left"><span class="table-header">Properties</span></td>
257 <td align="right" valign="top"
258 ><span class="options">[<a href="#section-Properties"
259 class="privatelink" onclick="toggle_private();"
260 >hide private</a>]</span></td>
261 </tr>
262 </table>
263 </td>
264</tr>
265 <tr>
266 <td colspan="2" class="summary">
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]267 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
268 <code>__class__</code>
269 </p>
270 </td>
271 </tr>
272</table>
273<!-- ==================== METHOD DETAILS ==================== -->
274<a name="section-MethodDetails"></a>
275<table class="details" border="1" cellpadding="3"
276 cellspacing="0" width="100%" bgcolor="white">
277<tr bgcolor="#70b0f0" class="table-header">
278 <td colspan="2" class="table-header">
279 <table border="0" cellpadding="0" cellspacing="0" width="100%">
280 <tr valign="top">
281 <td align="left"><span class="table-header">Method Details</span></td>
282 <td align="right" valign="top"
283 ><span class="options">[<a href="#section-MethodDetails"
284 class="privatelink" onclick="toggle_private();"
285 >hide private</a>]</span></td>
286 </tr>
287 </table>
288 </td>
289</tr>
290</table>
291<a name="__init__"></a>
292<div>
293<table class="details" border="1" cellpadding="3"
294 cellspacing="0" width="100%" bgcolor="white">
295<tr><td>
296 <table width="100%" cellpadding="0" cellspacing="0" border="0">
297 <tr valign="top"><td>
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]298 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
299 <span class="sig-arg">scope</span>,
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]300 <span class="sig-arg">**kwargs</span>)</span>
301 <br /><em class="fname">(Constructor)</em>
302 </h3>
303 </td><td align="right" valign="top"
Joe Gregoriof4839b02012-09-06 13:47:24 -0400[diff] [blame]304 ><span class="codelink"><a href="oauth2client.gce-pysrc.html#AppAssertionCredentials.__init__">source&nbsp;code</a></span>&nbsp;
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]305 </td>
306 </tr></table>
307
308 <pre class="literalblock">
309Constructor for AppAssertionCredentials
310
311Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]312 scope: string or iterable of strings, scope(s) of the credentials being
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]313 requested.
314
315</pre>
316 <dl class="fields">
317 <dt>Decorators:</dt>
318 <dd><ul class="nomargin-top">
319 <li><code>@util.positional(2)</code></li>
320 </ul></dd>
321 <dt>Overrides:
322 object.__init__
323 </dt>
324 </dl>
325</td></tr></table>
326</div>
327<a name="from_json"></a>
328<div>
329<table class="details" border="1" cellpadding="3"
330 cellspacing="0" width="100%" bgcolor="white">
331<tr><td>
332 <table width="100%" cellpadding="0" cellspacing="0" border="0">
333 <tr valign="top"><td>
334 <h3 class="epydoc"><span class="sig"><span class="sig-name">from_json</span>(<span class="sig-arg">cls</span>,
335 <span class="sig-arg">json</span>)</span>
336 <br /><em class="fname">Class Method</em>
337 </h3>
338 </td><td align="right" valign="top"
339 ><span class="codelink"><a href="oauth2client.gce-pysrc.html#AppAssertionCredentials.from_json">source&nbsp;code</a></span>&nbsp;
340 </td>
341 </tr></table>
342
343 <pre class="literalblock">
344Instantiate a Credentials object from a JSON description of it. The JSON
345should have been produced by calling .to_json() on the object.
346
347Args:
348 data: dict, A deserialized JSON object.
349
350Returns:
351 An instance of a Credentials subclass.
352
353</pre>
354 <dl class="fields">
355 <dt>Overrides:
356 <a href="oauth2client.client.Credentials-class.html#from_json">client.Credentials.from_json</a>
357 <dd><em class="note">(inherited documentation)</em></dd>
358 </dt>
359 </dl>
360</td></tr></table>
361</div>
362<a name="_refresh"></a>
363<div class="private">
364<table class="details" border="1" cellpadding="3"
365 cellspacing="0" width="100%" bgcolor="white">
366<tr><td>
367 <table width="100%" cellpadding="0" cellspacing="0" border="0">
368 <tr valign="top"><td>
369 <h3 class="epydoc"><span class="sig"><span class="sig-name">_refresh</span>(<span class="sig-arg">self</span>,
370 <span class="sig-arg">http_request</span>)</span>
371 </h3>
372 </td><td align="right" valign="top"
373 ><span class="codelink"><a href="oauth2client.gce-pysrc.html#AppAssertionCredentials._refresh">source&nbsp;code</a></span>&nbsp;
374 </td>
375 </tr></table>
376
377 <pre class="literalblock">
378Refreshes the access_token.
379
380Skip all the storage hoops and just refresh using the API.
381
382Args:
383 http_request: callable, a callable that matches the method signature of
384 httplib2.Http.request, used to make the refresh request.
385
386Raises:
387 AccessTokenRefreshError: When the refresh fails.
388
389</pre>
390 <dl class="fields">
391 <dt>Overrides:
392 <a href="oauth2client.client.OAuth2Credentials-class.html#_refresh" onclick="show_private();">client.OAuth2Credentials._refresh</a>
393 </dt>
394 </dl>
395</td></tr></table>
396</div>
397<br />
398<!-- ==================== NAVIGATION BAR ==================== -->
399<table class="navbar" border="0" width="100%" cellpadding="0"
400 bgcolor="#a0c0ff" cellspacing="0">
401 <tr valign="middle">
402
403 <!-- Tree link -->
404 <th>&nbsp;&nbsp;&nbsp;<a
405 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
406
407 <!-- Index link -->
408 <th>&nbsp;&nbsp;&nbsp;<a
409 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
410
411 <!-- Help link -->
412 <th>&nbsp;&nbsp;&nbsp;<a
413 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
414
415 <th class="navbar" width="100%"></th>
416 </tr>
417</table>
418<table border="0" cellpadding="0" cellspacing="0" width="100%%">
419 <tr>
420 <td align="left" class="footer">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]421 Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:25 2013
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]422 </td>
423 <td align="right" class="footer">
424 <a target="mainFrame" href="http://epydoc.sourceforge.net"
425 >http://epydoc.sourceforge.net</a>
426 </td>
427 </tr>
428</table>
429
430<script type="text/javascript">
431 <!--
432 // Private objects are initially displayed (because if
433 // javascript is turned off then we want them to be
434 // visible); but by default, we want to hide them. So hide
435 // them unless we have a cookie that says to show them.
436 checkCookie();
437 // -->
438</script>
439</body>
440</html>