Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f3348f98bf91a88a28bf61b12b95e391cc3be1ff / . / docs / dyn / taskqueue_v1beta1.tasks.html
blob: 9abaaafa5d1baee6c8f464b212897fce48c92d62 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="taskqueue_v1beta1.html">TaskQueue API</a> . <a href="taskqueue_v1beta1.tasks.html">tasks</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, taskqueue, task)</a></code></p>
79<p class="firstline">Delete a task from a TaskQueue.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, taskqueue, task)</a></code></p>
82<p class="firstline">Get a particular task from a TaskQueue.</p>
83<p class="toc_element">
84 <code><a href="#lease">lease(project, taskqueue, numTasks, leaseSecs)</a></code></p>
85<p class="firstline">Lease 1 or more tasks from a TaskQueue.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, taskqueue)</a></code></p>
88<p class="firstline">List Tasks in a TaskQueue</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(project, taskqueue, task)</code>
92 <pre>Delete a task from a TaskQueue.
93
94Args:
95 project: string, The project under which the queue lies. (required)
96 taskqueue: string, The taskqueue to delete a task from. (required)
97 task: string, The id of the task to delete. (required)
98</pre>
99</div>
100
101<div class="method">
102 <code class="details" id="get">get(project, taskqueue, task)</code>
103 <pre>Get a particular task from a TaskQueue.
104
105Args:
106 project: string, The project under which the queue lies. (required)
107 taskqueue: string, The taskqueue in which the task belongs. (required)
108 task: string, The task to get properties of. (required)
109
110Returns:
111 An object of the form:
112
113 {
114 "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
115 "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
116 "id": "A String", # Name of the task.
117 "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
118 "queueName": "A String", # Name of the queue that the task is in.
119 "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
120 }</pre>
121</div>
122
123<div class="method">
124 <code class="details" id="lease">lease(project, taskqueue, numTasks, leaseSecs)</code>
125 <pre>Lease 1 or more tasks from a TaskQueue.
126
127Args:
128 project: string, The project under which the queue lies. (required)
129 taskqueue: string, The taskqueue to lease a task from. (required)
130 numTasks: integer, The number of tasks to lease. (required)
131 leaseSecs: integer, The lease in seconds. (required)
132
133Returns:
134 An object of the form:
135
136 {
137 "items": [ # The actual list of tasks returned as a result of the lease operation.
138 {
139 "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
140 "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
141 "id": "A String", # Name of the task.
142 "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
143 "queueName": "A String", # Name of the queue that the task is in.
144 "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
145 },
146 ],
147 "kind": "taskqueue#tasks", # The kind of object returned, a list of tasks.
148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="list">list(project, taskqueue)</code>
153 <pre>List Tasks in a TaskQueue
154
155Args:
156 project: string, The project under which the queue lies. (required)
157 taskqueue: string, The id of the taskqueue to list tasks from. (required)
158
159Returns:
160 An object of the form:
161
162 {
163 "items": [ # The actual list of tasks currently active in the TaskQueue.
164 {
165 "kind": "taskqueues#task", # The kind of object returned, in this case set to task.
166 "leaseTimestamp": "A String", # Time (in seconds since the epoch) at which the task lease will expire. This value is 0 if the task isnt currently leased out to a worker.
167 "id": "A String", # Name of the task.
168 "payloadBase64": "A String", # A bag of bytes which is the task payload. The payload on the JSON side is always Base64 encoded.
169 "queueName": "A String", # Name of the queue that the task is in.
170 "enqueueTimestamp": "A String", # Time (in seconds since the epoch) at which the task was enqueued.
171 },
172 ],
173 "kind": "taskqueues#tasks", # The kind of object returned, a list of tasks.
174 }</pre>
175</div>
176
177</body></html>