Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b417caf3c9cfa17ebce4d08357d67d9d88c67c21 / . / docs / dyn / taskqueue.v1beta1.tasks.html
blob: 3aea7f4b565b90ccaf1066ac9df4077dbd9a1790 [file] [log] [blame]
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<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>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete&nbsp;a&nbsp;task&nbsp;from&nbsp;a&nbsp;TaskQueue.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;task:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;task&nbsp;to&nbsp;delete.&nbsp;(required)<br>
21&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;The&nbsp;taskqueue&nbsp;to&nbsp;delete&nbsp;a&nbsp;task&nbsp;from.&nbsp;(required)<br>
22&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)</tt></dd></dl>
23
24<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;particular&nbsp;task&nbsp;from&nbsp;a&nbsp;TaskQueue.<br>
25&nbsp;<br>
26Args:<br>
27&nbsp;&nbsp;task:&nbsp;string,&nbsp;The&nbsp;task&nbsp;to&nbsp;get&nbsp;properties&nbsp;of.&nbsp;(required)<br>
28&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;The&nbsp;taskqueue&nbsp;in&nbsp;which&nbsp;the&nbsp;task&nbsp;belongs.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame^]29&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)<br>
30&nbsp;<br>
31Returns:<br>
32&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
33&nbsp;<br>
34&nbsp;&nbsp;&nbsp;&nbsp;{<br>
35&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"taskqueues#task",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;object&nbsp;returned,&nbsp;in&nbsp;this&nbsp;case&nbsp;set&nbsp;to&nbsp;task.<br>
36&nbsp;&nbsp;&nbsp;&nbsp;"leaseTimestamp":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;(in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch)&nbsp;at&nbsp;which&nbsp;the&nbsp;task&nbsp;lease&nbsp;will&nbsp;expire.&nbsp;This&nbsp;value&nbsp;is&nbsp;0&nbsp;if&nbsp;the&nbsp;task&nbsp;isnt&nbsp;currently&nbsp;leased&nbsp;out&nbsp;to&nbsp;a&nbsp;worker.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
38&nbsp;&nbsp;&nbsp;&nbsp;"payloadBase64":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;bag&nbsp;of&nbsp;bytes&nbsp;which&nbsp;is&nbsp;the&nbsp;task&nbsp;payload.&nbsp;The&nbsp;payload&nbsp;on&nbsp;the&nbsp;JSON&nbsp;side&nbsp;is&nbsp;always&nbsp;Base64&nbsp;encoded.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;"queueName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;queue&nbsp;that&nbsp;the&nbsp;task&nbsp;is&nbsp;in.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;"enqueueTimestamp":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;(in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch)&nbsp;at&nbsp;which&nbsp;the&nbsp;task&nbsp;was&nbsp;enqueued.<br>
41&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]42
43<dl><dt><a name="Resource-lease"><strong>lease</strong></a> = method(self, **kwargs)</dt><dd><tt>Lease&nbsp;1&nbsp;or&nbsp;more&nbsp;tasks&nbsp;from&nbsp;a&nbsp;TaskQueue.<br>
44&nbsp;<br>
45Args:<br>
46&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
47&nbsp;&nbsp;leaseSecs:&nbsp;integer,&nbsp;The&nbsp;lease&nbsp;in&nbsp;seconds.&nbsp;(required)<br>
48&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;The&nbsp;taskqueue&nbsp;to&nbsp;lease&nbsp;a&nbsp;task&nbsp;from.&nbsp;(required)<br>
49&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame^]50&nbsp;&nbsp;numTasks:&nbsp;integer,&nbsp;The&nbsp;number&nbsp;of&nbsp;tasks&nbsp;to&nbsp;lease.&nbsp;(required)<br>
51&nbsp;<br>
52Returns:<br>
53&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
54&nbsp;<br>
55&nbsp;&nbsp;&nbsp;&nbsp;{<br>
56&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;actual&nbsp;list&nbsp;of&nbsp;tasks&nbsp;returned&nbsp;as&nbsp;a&nbsp;result&nbsp;of&nbsp;the&nbsp;lease&nbsp;operation.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"taskqueues#task",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;object&nbsp;returned,&nbsp;in&nbsp;this&nbsp;case&nbsp;set&nbsp;to&nbsp;task.<br>
59&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"leaseTimestamp":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;(in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch)&nbsp;at&nbsp;which&nbsp;the&nbsp;task&nbsp;lease&nbsp;will&nbsp;expire.&nbsp;This&nbsp;value&nbsp;is&nbsp;0&nbsp;if&nbsp;the&nbsp;task&nbsp;isnt&nbsp;currently&nbsp;leased&nbsp;out&nbsp;to&nbsp;a&nbsp;worker.<br>
60&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
61&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"payloadBase64":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;bag&nbsp;of&nbsp;bytes&nbsp;which&nbsp;is&nbsp;the&nbsp;task&nbsp;payload.&nbsp;The&nbsp;payload&nbsp;on&nbsp;the&nbsp;JSON&nbsp;side&nbsp;is&nbsp;always&nbsp;Base64&nbsp;encoded.<br>
62&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"queueName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;queue&nbsp;that&nbsp;the&nbsp;task&nbsp;is&nbsp;in.<br>
63&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enqueueTimestamp":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;(in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch)&nbsp;at&nbsp;which&nbsp;the&nbsp;task&nbsp;was&nbsp;enqueued.<br>
64&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
65&nbsp;&nbsp;&nbsp;&nbsp;],<br>
66&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"taskqueue#tasks",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;object&nbsp;returned,&nbsp;a&nbsp;list&nbsp;of&nbsp;tasks.<br>
67&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]68
69<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;Tasks&nbsp;in&nbsp;a&nbsp;TaskQueue<br>
70&nbsp;<br>
71Args:<br>
72&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;taskqueue&nbsp;to&nbsp;list&nbsp;tasks&nbsp;from.&nbsp;(required)<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame^]73&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)<br>
74&nbsp;<br>
75Returns:<br>
76&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
77&nbsp;<br>
78&nbsp;&nbsp;&nbsp;&nbsp;{<br>
79&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;The&nbsp;actual&nbsp;list&nbsp;of&nbsp;tasks&nbsp;currently&nbsp;active&nbsp;in&nbsp;the&nbsp;TaskQueue.<br>
80&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"taskqueues#task",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;object&nbsp;returned,&nbsp;in&nbsp;this&nbsp;case&nbsp;set&nbsp;to&nbsp;task.<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"leaseTimestamp":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;(in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch)&nbsp;at&nbsp;which&nbsp;the&nbsp;task&nbsp;lease&nbsp;will&nbsp;expire.&nbsp;This&nbsp;value&nbsp;is&nbsp;0&nbsp;if&nbsp;the&nbsp;task&nbsp;isnt&nbsp;currently&nbsp;leased&nbsp;out&nbsp;to&nbsp;a&nbsp;worker.<br>
83&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
84&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"payloadBase64":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;A&nbsp;bag&nbsp;of&nbsp;bytes&nbsp;which&nbsp;is&nbsp;the&nbsp;task&nbsp;payload.&nbsp;The&nbsp;payload&nbsp;on&nbsp;the&nbsp;JSON&nbsp;side&nbsp;is&nbsp;always&nbsp;Base64&nbsp;encoded.<br>
85&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"queueName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;queue&nbsp;that&nbsp;the&nbsp;task&nbsp;is&nbsp;in.<br>
86&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enqueueTimestamp":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;(in&nbsp;seconds&nbsp;since&nbsp;the&nbsp;epoch)&nbsp;at&nbsp;which&nbsp;the&nbsp;task&nbsp;was&nbsp;enqueued.<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
88&nbsp;&nbsp;&nbsp;&nbsp;],<br>
89&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"taskqueues#tasks",&nbsp;#&nbsp;The&nbsp;kind&nbsp;of&nbsp;object&nbsp;returned,&nbsp;a&nbsp;list&nbsp;of&nbsp;tasks.<br>
90&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio351b1492011-05-08 23:32:46 -0700[diff] [blame]91
92<hr>
93Data descriptors defined here:<br>
94<dl><dt><strong>__dict__</strong></dt>
95<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
96</dl>
97<dl><dt><strong>__weakref__</strong></dt>
98<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
99</dl>
100</td></tr></table>
101</body></html>