blob: acedcd77ae3065200be768d6ee9e8f3b5ed604dc [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: class Resource</title>
</head><body bgcolor="#f0f0f8">
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;detailed&nbsp;information&nbsp;about&nbsp;a&nbsp;TaskQueue.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;taskqueue&nbsp;to&nbsp;get&nbsp;the&nbsp;properties&nbsp;of.&nbsp;(required)<br>
&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)<br>
&nbsp;&nbsp;getStats:&nbsp;boolean,&nbsp;Whether&nbsp;to&nbsp;get&nbsp;stats.&nbsp;Optional.<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"taskqueues#taskqueue",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;REST&nbsp;object&nbsp;returned,&nbsp;in&nbsp;this&nbsp;case&nbsp;taskqueue.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"stats":&nbsp;{&nbsp;#&nbsp;Statistics&nbsp;for&nbsp;the&nbsp;TaskQueue&nbsp;object&nbsp;in&nbsp;question.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"oldestTask":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;timestamp&nbsp;(in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch)&nbsp;of&nbsp;the&nbsp;oldest&nbsp;unfinished&nbsp;task.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"leasedLastMinute":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Number&nbsp;of&nbsp;tasks&nbsp;leased&nbsp;in&nbsp;the&nbsp;last&nbsp;minute.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"totalTasks":&nbsp;42,&nbsp;#&nbsp;Number&nbsp;of&nbsp;tasks&nbsp;in&nbsp;the&nbsp;queue.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"leasedLastHour":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Number&nbsp;of&nbsp;tasks&nbsp;leased&nbsp;in&nbsp;the&nbsp;last&nbsp;hour.<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;taskqueue.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"maxLeases":&nbsp;42,&nbsp;#&nbsp;The&nbsp;number&nbsp;of&nbsp;times&nbsp;we&nbsp;should&nbsp;lease&nbsp;out&nbsp;tasks&nbsp;before&nbsp;giving&nbsp;up&nbsp;on&nbsp;them.&nbsp;If&nbsp;unset&nbsp;we&nbsp;lease&nbsp;them&nbsp;out&nbsp;forever&nbsp;until&nbsp;a&nbsp;worker&nbsp;deletes&nbsp;the&nbsp;task.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"acl":&nbsp;{&nbsp;#&nbsp;ACLs&nbsp;that&nbsp;are&nbsp;applicable&nbsp;to&nbsp;this&nbsp;TaskQueue&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"consumerEmails":&nbsp;[&nbsp;#&nbsp;Email&nbsp;addresses&nbsp;of&nbsp;users&nbsp;who&nbsp;can&nbsp;"consume"&nbsp;tasks&nbsp;from&nbsp;the&nbsp;TaskQueue.&nbsp;This&nbsp;means&nbsp;they&nbsp;can&nbsp;Dequeue&nbsp;and&nbsp;Delete&nbsp;tasks&nbsp;from&nbsp;the&nbsp;queue.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"producerEmails":&nbsp;[&nbsp;#&nbsp;Email&nbsp;addresses&nbsp;of&nbsp;users&nbsp;who&nbsp;can&nbsp;"produce"&nbsp;tasks&nbsp;into&nbsp;the&nbsp;TaskQueue.&nbsp;This&nbsp;means&nbsp;they&nbsp;can&nbsp;Insert&nbsp;tasks&nbsp;into&nbsp;the&nbsp;queue.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"adminEmails":&nbsp;[&nbsp;#&nbsp;Email&nbsp;addresses&nbsp;of&nbsp;users&nbsp;who&nbsp;are&nbsp;"admins"&nbsp;of&nbsp;the&nbsp;TaskQueue.&nbsp;This&nbsp;means&nbsp;they&nbsp;can&nbsp;control&nbsp;the&nbsp;queue,&nbsp;eg&nbsp;set&nbsp;ACLs&nbsp;for&nbsp;the&nbsp;queue.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"A&nbsp;String",<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;}</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>