Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / ebd0b8402b34d30c7c0ee4fa2198f48f1bcfd62b / . / docs / dyn / taskqueue.v1beta2.tasks.html
blob: 94af2915c6357b2f3fd9db2238905040bcf30215 [file] [log] [blame]
Joe Gregorio66212032012-06-14 09:10:14 -0400[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;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)<br>
21&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
22&nbsp;&nbsp;task:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;task&nbsp;to&nbsp;delete.&nbsp;(required)<br>
23&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
24&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;The&nbsp;taskqueue&nbsp;to&nbsp;delete&nbsp;a&nbsp;task&nbsp;from.&nbsp;(required)<br>
25&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
26&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter</tt></dd></dl>
27
28<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>
29&nbsp;<br>
30Args:<br>
31&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)<br>
32&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
33&nbsp;&nbsp;task:&nbsp;string,&nbsp;The&nbsp;task&nbsp;to&nbsp;get&nbsp;properties&nbsp;of.&nbsp;(required)<br>
34&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
35&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;The&nbsp;taskqueue&nbsp;in&nbsp;which&nbsp;the&nbsp;task&nbsp;belongs.&nbsp;(required)<br>
36&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
37&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
38&nbsp;<br>
39Returns:<br>
40&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
41&nbsp;<br>
42&nbsp;&nbsp;&nbsp;&nbsp;{<br>
43&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>
44&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>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Tag&nbsp;for&nbsp;the&nbsp;task,&nbsp;could&nbsp;be&nbsp;used&nbsp;later&nbsp;to&nbsp;lease&nbsp;tasks&nbsp;grouped&nbsp;by&nbsp;a&nbsp;specific&nbsp;tag.<br>
47&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>
48&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>
49&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>
50&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
51
52<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Insert&nbsp;a&nbsp;new&nbsp;task&nbsp;in&nbsp;a&nbsp;TaskQueue<br>
53&nbsp;<br>
54Args:<br>
55&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
56&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
57&nbsp;<br>
58{<br>
59&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>
60&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>
61&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
62&nbsp;&nbsp;&nbsp;&nbsp;"tag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Tag&nbsp;for&nbsp;the&nbsp;task,&nbsp;could&nbsp;be&nbsp;used&nbsp;later&nbsp;to&nbsp;lease&nbsp;tasks&nbsp;grouped&nbsp;by&nbsp;a&nbsp;specific&nbsp;tag.<br>
63&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>
64&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>
65&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>
66&nbsp;&nbsp;}<br>
67&nbsp;<br>
68&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies&nbsp;(required)<br>
69&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
70&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
71&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;The&nbsp;taskqueue&nbsp;to&nbsp;insert&nbsp;the&nbsp;task&nbsp;into&nbsp;(required)<br>
72&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
73&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<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;&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>
80&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>
81&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
82&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Tag&nbsp;for&nbsp;the&nbsp;task,&nbsp;could&nbsp;be&nbsp;used&nbsp;later&nbsp;to&nbsp;lease&nbsp;tasks&nbsp;grouped&nbsp;by&nbsp;a&nbsp;specific&nbsp;tag.<br>
83&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>
84&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>
85&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>
86&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
87
88<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>
89&nbsp;<br>
90Args:<br>
91&nbsp;&nbsp;groupByTag:&nbsp;boolean,&nbsp;When&nbsp;true,&nbsp;all&nbsp;returned&nbsp;tasks&nbsp;will&nbsp;have&nbsp;the&nbsp;same&nbsp;tag<br>
92&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)<br>
93&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
94&nbsp;&nbsp;leaseSecs:&nbsp;integer,&nbsp;The&nbsp;lease&nbsp;in&nbsp;seconds.&nbsp;(required)<br>
95&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;The&nbsp;taskqueue&nbsp;to&nbsp;lease&nbsp;a&nbsp;task&nbsp;from.&nbsp;(required)<br>
96&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
97&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
98&nbsp;&nbsp;tag:&nbsp;string,&nbsp;The&nbsp;tag&nbsp;allowed&nbsp;for&nbsp;tasks&nbsp;in&nbsp;the&nbsp;response.&nbsp;Must&nbsp;only&nbsp;be&nbsp;specified&nbsp;if&nbsp;group_by_tag&nbsp;is&nbsp;true.&nbsp;If&nbsp;group_by_tag&nbsp;is&nbsp;true&nbsp;and&nbsp;tag&nbsp;is&nbsp;not&nbsp;specified&nbsp;the&nbsp;tag&nbsp;will&nbsp;be&nbsp;that&nbsp;of&nbsp;the&nbsp;oldest&nbsp;task&nbsp;by&nbsp;eta,&nbsp;i.e.&nbsp;the&nbsp;first&nbsp;available&nbsp;tag<br>
99&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
100&nbsp;&nbsp;numTasks:&nbsp;integer,&nbsp;The&nbsp;number&nbsp;of&nbsp;tasks&nbsp;to&nbsp;lease.&nbsp;(required)<br>
101&nbsp;<br>
102Returns:<br>
103&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
104&nbsp;<br>
105&nbsp;&nbsp;&nbsp;&nbsp;{<br>
106&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>
107&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
108&nbsp;&nbsp;&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>
109&nbsp;&nbsp;&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>
110&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
111&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Tag&nbsp;for&nbsp;the&nbsp;task,&nbsp;could&nbsp;be&nbsp;used&nbsp;later&nbsp;to&nbsp;lease&nbsp;tasks&nbsp;grouped&nbsp;by&nbsp;a&nbsp;specific&nbsp;tag.<br>
112&nbsp;&nbsp;&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>
113&nbsp;&nbsp;&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>
114&nbsp;&nbsp;&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>
115&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
116&nbsp;&nbsp;&nbsp;&nbsp;],<br>
117&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>
118&nbsp;&nbsp;}</tt></dd></dl>
119
120<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>
121&nbsp;<br>
122Args:<br>
123&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)<br>
124&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
125&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
126&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>
127&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
128&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
129&nbsp;<br>
130Returns:<br>
131&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
132&nbsp;<br>
133&nbsp;&nbsp;&nbsp;&nbsp;{<br>
134&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>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
136&nbsp;&nbsp;&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>
137&nbsp;&nbsp;&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>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Tag&nbsp;for&nbsp;the&nbsp;task,&nbsp;could&nbsp;be&nbsp;used&nbsp;later&nbsp;to&nbsp;lease&nbsp;tasks&nbsp;grouped&nbsp;by&nbsp;a&nbsp;specific&nbsp;tag.<br>
140&nbsp;&nbsp;&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>
141&nbsp;&nbsp;&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>
142&nbsp;&nbsp;&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>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
144&nbsp;&nbsp;&nbsp;&nbsp;],<br>
145&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>
146&nbsp;&nbsp;}</tt></dd></dl>
147
148<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Update&nbsp;tasks&nbsp;that&nbsp;are&nbsp;leased&nbsp;out&nbsp;of&nbsp;a&nbsp;TaskQueue.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
149&nbsp;<br>
150Args:<br>
151&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
152&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
153&nbsp;<br>
154{<br>
155&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>
156&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>
157&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
158&nbsp;&nbsp;&nbsp;&nbsp;"tag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Tag&nbsp;for&nbsp;the&nbsp;task,&nbsp;could&nbsp;be&nbsp;used&nbsp;later&nbsp;to&nbsp;lease&nbsp;tasks&nbsp;grouped&nbsp;by&nbsp;a&nbsp;specific&nbsp;tag.<br>
159&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>
160&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>
161&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>
162&nbsp;&nbsp;}<br>
163&nbsp;<br>
164&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)<br>
165&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
166&nbsp;&nbsp;task:&nbsp;string,&nbsp;A&nbsp;parameter&nbsp;(required)<br>
167&nbsp;&nbsp;newLeaseSeconds:&nbsp;integer,&nbsp;The&nbsp;new&nbsp;lease&nbsp;in&nbsp;seconds.&nbsp;(required)<br>
168&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
169&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;A&nbsp;parameter&nbsp;(required)<br>
170&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
171&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
172&nbsp;<br>
173Returns:<br>
174&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
175&nbsp;<br>
176&nbsp;&nbsp;&nbsp;&nbsp;{<br>
177&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>
178&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>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Tag&nbsp;for&nbsp;the&nbsp;task,&nbsp;could&nbsp;be&nbsp;used&nbsp;later&nbsp;to&nbsp;lease&nbsp;tasks&nbsp;grouped&nbsp;by&nbsp;a&nbsp;specific&nbsp;tag.<br>
181&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>
182&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>
183&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>
184&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
185
186<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update&nbsp;tasks&nbsp;that&nbsp;are&nbsp;leased&nbsp;out&nbsp;of&nbsp;a&nbsp;TaskQueue.<br>
187&nbsp;<br>
188Args:<br>
189&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
190&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
191&nbsp;<br>
192{<br>
193&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>
194&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>
195&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
196&nbsp;&nbsp;&nbsp;&nbsp;"tag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Tag&nbsp;for&nbsp;the&nbsp;task,&nbsp;could&nbsp;be&nbsp;used&nbsp;later&nbsp;to&nbsp;lease&nbsp;tasks&nbsp;grouped&nbsp;by&nbsp;a&nbsp;specific&nbsp;tag.<br>
197&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>
198&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>
199&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>
200&nbsp;&nbsp;}<br>
201&nbsp;<br>
202&nbsp;&nbsp;project:&nbsp;string,&nbsp;The&nbsp;project&nbsp;under&nbsp;which&nbsp;the&nbsp;queue&nbsp;lies.&nbsp;(required)<br>
203&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
204&nbsp;&nbsp;task:&nbsp;string,&nbsp;A&nbsp;parameter&nbsp;(required)<br>
205&nbsp;&nbsp;newLeaseSeconds:&nbsp;integer,&nbsp;The&nbsp;new&nbsp;lease&nbsp;in&nbsp;seconds.&nbsp;(required)<br>
206&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
207&nbsp;&nbsp;taskqueue:&nbsp;string,&nbsp;A&nbsp;parameter&nbsp;(required)<br>
208&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
209&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
210&nbsp;<br>
211Returns:<br>
212&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
213&nbsp;<br>
214&nbsp;&nbsp;&nbsp;&nbsp;{<br>
215&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>
216&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>
217&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;the&nbsp;task.<br>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tag":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Tag&nbsp;for&nbsp;the&nbsp;task,&nbsp;could&nbsp;be&nbsp;used&nbsp;later&nbsp;to&nbsp;lease&nbsp;tasks&nbsp;grouped&nbsp;by&nbsp;a&nbsp;specific&nbsp;tag.<br>
219&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>
220&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>
221&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>
222&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
223
224<hr>
225Data descriptors defined here:<br>
226<dl><dt><strong>__dict__</strong></dt>
227<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
228</dl>
229<dl><dt><strong>__weakref__</strong></dt>
230<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
231</dl>
232</td></tr></table>
233</body></html>