authorizer / vendor / google-api-php-client / src / Google / Service / Taskqueue.php

Taskqueue.php in Authorizer 2.6.17, at vendor/google-api-php-client/src/Google/Service/Taskqueue.php

689 lines 19.7 KB

Raw Download Zip

1	<?php
2	/*
3	* Licensed under the Apache License, Version 2.0 (the "License"); you may not
4	* use this file except in compliance with the License. You may obtain a copy of
5	* the License at
6	*
7	* http://www.apache.org/licenses/LICENSE-2.0
8	*
9	* Unless required by applicable law or agreed to in writing, software
10	* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11	* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12	* License for the specific language governing permissions and limitations under
13	* the License.
14	*/
15
16	/**
17	* Service definition for Taskqueue (v1beta2).
18	*
19	* <p>
20	* Lets you access a Google App Engine Pull Task Queue over REST.</p>
21	*
22	* <p>
23	* For more information about this service, see the API
24	* <a href="https://developers.google.com/appengine/docs/python/taskqueue/rest" target="_blank">Documentation</a>
25	* </p>
26	*
27	* @author Google, Inc.
28	*/
29	class Google_Service_Taskqueue extends Google_Service
30	{
31	/** Manage your Tasks and Taskqueues. */
32	const TASKQUEUE =
33	"https://www.googleapis.com/auth/taskqueue";
34	/** Consume Tasks from your Taskqueues. */
35	const TASKQUEUE_CONSUMER =
36	"https://www.googleapis.com/auth/taskqueue.consumer";
37
38	public $taskqueues;
39	public $tasks;
40
41
42	/**
43	* Constructs the internal representation of the Taskqueue service.
44	*
45	* @param Google_Client $client
46	*/
47	public function __construct(Google_Client $client)
48	{
49	parent::__construct($client);
50	$this->rootUrl = 'https://www.googleapis.com/';
51	$this->servicePath = 'taskqueue/v1beta2/projects/';
52	$this->version = 'v1beta2';
53	$this->serviceName = 'taskqueue';
54
55	$this->taskqueues = new Google_Service_Taskqueue_Taskqueues_Resource(
56	$this,
57	$this->serviceName,
58	'taskqueues',
59	array(
60	'methods' => array(
61	'get' => array(
62	'path' => '{project}/taskqueues/{taskqueue}',
63	'httpMethod' => 'GET',
64	'parameters' => array(
65	'project' => array(
66	'location' => 'path',
67	'type' => 'string',
68	'required' => true,
69	),
70	'taskqueue' => array(
71	'location' => 'path',
72	'type' => 'string',
73	'required' => true,
74	),
75	'getStats' => array(
76	'location' => 'query',
77	'type' => 'boolean',
78	),
79	),
80	),
81	)
82	)
83	);
84	$this->tasks = new Google_Service_Taskqueue_Tasks_Resource(
85	$this,
86	$this->serviceName,
87	'tasks',
88	array(
89	'methods' => array(
90	'delete' => array(
91	'path' => '{project}/taskqueues/{taskqueue}/tasks/{task}',
92	'httpMethod' => 'DELETE',
93	'parameters' => array(
94	'project' => array(
95	'location' => 'path',
96	'type' => 'string',
97	'required' => true,
98	),
99	'taskqueue' => array(
100	'location' => 'path',
101	'type' => 'string',
102	'required' => true,
103	),
104	'task' => array(
105	'location' => 'path',
106	'type' => 'string',
107	'required' => true,
108	),
109	),
110	),'get' => array(
111	'path' => '{project}/taskqueues/{taskqueue}/tasks/{task}',
112	'httpMethod' => 'GET',
113	'parameters' => array(
114	'project' => array(
115	'location' => 'path',
116	'type' => 'string',
117	'required' => true,
118	),
119	'taskqueue' => array(
120	'location' => 'path',
121	'type' => 'string',
122	'required' => true,
123	),
124	'task' => array(
125	'location' => 'path',
126	'type' => 'string',
127	'required' => true,
128	),
129	),
130	),'insert' => array(
131	'path' => '{project}/taskqueues/{taskqueue}/tasks',
132	'httpMethod' => 'POST',
133	'parameters' => array(
134	'project' => array(
135	'location' => 'path',
136	'type' => 'string',
137	'required' => true,
138	),
139	'taskqueue' => array(
140	'location' => 'path',
141	'type' => 'string',
142	'required' => true,
143	),
144	),
145	),'lease' => array(
146	'path' => '{project}/taskqueues/{taskqueue}/tasks/lease',
147	'httpMethod' => 'POST',
148	'parameters' => array(
149	'project' => array(
150	'location' => 'path',
151	'type' => 'string',
152	'required' => true,
153	),
154	'taskqueue' => array(
155	'location' => 'path',
156	'type' => 'string',
157	'required' => true,
158	),
159	'numTasks' => array(
160	'location' => 'query',
161	'type' => 'integer',
162	'required' => true,
163	),
164	'leaseSecs' => array(
165	'location' => 'query',
166	'type' => 'integer',
167	'required' => true,
168	),
169	'groupByTag' => array(
170	'location' => 'query',
171	'type' => 'boolean',
172	),
173	'tag' => array(
174	'location' => 'query',
175	'type' => 'string',
176	),
177	),
178	),'list' => array(
179	'path' => '{project}/taskqueues/{taskqueue}/tasks',
180	'httpMethod' => 'GET',
181	'parameters' => array(
182	'project' => array(
183	'location' => 'path',
184	'type' => 'string',
185	'required' => true,
186	),
187	'taskqueue' => array(
188	'location' => 'path',
189	'type' => 'string',
190	'required' => true,
191	),
192	),
193	),'patch' => array(
194	'path' => '{project}/taskqueues/{taskqueue}/tasks/{task}',
195	'httpMethod' => 'PATCH',
196	'parameters' => array(
197	'project' => array(
198	'location' => 'path',
199	'type' => 'string',
200	'required' => true,
201	),
202	'taskqueue' => array(
203	'location' => 'path',
204	'type' => 'string',
205	'required' => true,
206	),
207	'task' => array(
208	'location' => 'path',
209	'type' => 'string',
210	'required' => true,
211	),
212	'newLeaseSeconds' => array(
213	'location' => 'query',
214	'type' => 'integer',
215	'required' => true,
216	),
217	),
218	),'update' => array(
219	'path' => '{project}/taskqueues/{taskqueue}/tasks/{task}',
220	'httpMethod' => 'POST',
221	'parameters' => array(
222	'project' => array(
223	'location' => 'path',
224	'type' => 'string',
225	'required' => true,
226	),
227	'taskqueue' => array(
228	'location' => 'path',
229	'type' => 'string',
230	'required' => true,
231	),
232	'task' => array(
233	'location' => 'path',
234	'type' => 'string',
235	'required' => true,
236	),
237	'newLeaseSeconds' => array(
238	'location' => 'query',
239	'type' => 'integer',
240	'required' => true,
241	),
242	),
243	),
244	)
245	)
246	);
247	}
248	}
249
250
251	/**
252	* The "taskqueues" collection of methods.
253	* Typical usage is:
254	* <code>
255	* $taskqueueService = new Google_Service_Taskqueue(...);
256	* $taskqueues = $taskqueueService->taskqueues;
257	* </code>
258	*/
259	class Google_Service_Taskqueue_Taskqueues_Resource extends Google_Service_Resource
260	{
261
262	/**
263	* Get detailed information about a TaskQueue. (taskqueues.get)
264	*
265	* @param string $project The project under which the queue lies.
266	* @param string $taskqueue The id of the taskqueue to get the properties of.
267	* @param array $optParams Optional parameters.
268	*
269	* @opt_param bool getStats Whether to get stats. Optional.
270	* @return Google_Service_Taskqueue_TaskQueue
271	*/
272	public function get($project, $taskqueue, $optParams = array())
273	{
274	$params = array('project' => $project, 'taskqueue' => $taskqueue);
275	$params = array_merge($params, $optParams);
276	return $this->call('get', array($params), "Google_Service_Taskqueue_TaskQueue");
277	}
278	}
279
280	/**
281	* The "tasks" collection of methods.
282	* Typical usage is:
283	* <code>
284	* $taskqueueService = new Google_Service_Taskqueue(...);
285	* $tasks = $taskqueueService->tasks;
286	* </code>
287	*/
288	class Google_Service_Taskqueue_Tasks_Resource extends Google_Service_Resource
289	{
290
291	/**
292	* Delete a task from a TaskQueue. (tasks.delete)
293	*
294	* @param string $project The project under which the queue lies.
295	* @param string $taskqueue The taskqueue to delete a task from.
296	* @param string $task The id of the task to delete.
297	* @param array $optParams Optional parameters.
298	*/
299	public function delete($project, $taskqueue, $task, $optParams = array())
300	{
301	$params = array('project' => $project, 'taskqueue' => $taskqueue, 'task' => $task);
302	$params = array_merge($params, $optParams);
303	return $this->call('delete', array($params));
304	}
305
306	/**
307	* Get a particular task from a TaskQueue. (tasks.get)
308	*
309	* @param string $project The project under which the queue lies.
310	* @param string $taskqueue The taskqueue in which the task belongs.
311	* @param string $task The task to get properties of.
312	* @param array $optParams Optional parameters.
313	* @return Google_Service_Taskqueue_Task
314	*/
315	public function get($project, $taskqueue, $task, $optParams = array())
316	{
317	$params = array('project' => $project, 'taskqueue' => $taskqueue, 'task' => $task);
318	$params = array_merge($params, $optParams);
319	return $this->call('get', array($params), "Google_Service_Taskqueue_Task");
320	}
321
322	/**
323	* Insert a new task in a TaskQueue (tasks.insert)
324	*
325	* @param string $project The project under which the queue lies
326	* @param string $taskqueue The taskqueue to insert the task into
327	* @param Google_Task $postBody
328	* @param array $optParams Optional parameters.
329	* @return Google_Service_Taskqueue_Task
330	*/
331	public function insert($project, $taskqueue, Google_Service_Taskqueue_Task $postBody, $optParams = array())
332	{
333	$params = array('project' => $project, 'taskqueue' => $taskqueue, 'postBody' => $postBody);
334	$params = array_merge($params, $optParams);
335	return $this->call('insert', array($params), "Google_Service_Taskqueue_Task");
336	}
337
338	/**
339	* Lease 1 or more tasks from a TaskQueue. (tasks.lease)
340	*
341	* @param string $project The project under which the queue lies.
342	* @param string $taskqueue The taskqueue to lease a task from.
343	* @param int $numTasks The number of tasks to lease.
344	* @param int $leaseSecs The lease in seconds.
345	* @param array $optParams Optional parameters.
346	*
347	* @opt_param bool groupByTag When true, all returned tasks will have the same
348	* tag
349	* @opt_param string tag The tag allowed for tasks in the response. Must only be
350	* specified if group_by_tag is true. If group_by_tag is true and tag is not
351	* specified the tag will be that of the oldest task by eta, i.e. the first
352	* available tag
353	* @return Google_Service_Taskqueue_Tasks
354	*/
355	public function lease($project, $taskqueue, $numTasks, $leaseSecs, $optParams = array())
356	{
357	$params = array('project' => $project, 'taskqueue' => $taskqueue, 'numTasks' => $numTasks, 'leaseSecs' => $leaseSecs);
358	$params = array_merge($params, $optParams);
359	return $this->call('lease', array($params), "Google_Service_Taskqueue_Tasks");
360	}
361
362	/**
363	* List Tasks in a TaskQueue (tasks.listTasks)
364	*
365	* @param string $project The project under which the queue lies.
366	* @param string $taskqueue The id of the taskqueue to list tasks from.
367	* @param array $optParams Optional parameters.
368	* @return Google_Service_Taskqueue_Tasks2
369	*/
370	public function listTasks($project, $taskqueue, $optParams = array())
371	{
372	$params = array('project' => $project, 'taskqueue' => $taskqueue);
373	$params = array_merge($params, $optParams);
374	return $this->call('list', array($params), "Google_Service_Taskqueue_Tasks2");
375	}
376
377	/**
378	* Update tasks that are leased out of a TaskQueue. This method supports patch
379	* semantics. (tasks.patch)
380	*
381	* @param string $project The project under which the queue lies.
382	* @param string $taskqueue
383	* @param string $task
384	* @param int $newLeaseSeconds The new lease in seconds.
385	* @param Google_Task $postBody
386	* @param array $optParams Optional parameters.
387	* @return Google_Service_Taskqueue_Task
388	*/
389	public function patch($project, $taskqueue, $task, $newLeaseSeconds, Google_Service_Taskqueue_Task $postBody, $optParams = array())
390	{
391	$params = array('project' => $project, 'taskqueue' => $taskqueue, 'task' => $task, 'newLeaseSeconds' => $newLeaseSeconds, 'postBody' => $postBody);
392	$params = array_merge($params, $optParams);
393	return $this->call('patch', array($params), "Google_Service_Taskqueue_Task");
394	}
395
396	/**
397	* Update tasks that are leased out of a TaskQueue. (tasks.update)
398	*
399	* @param string $project The project under which the queue lies.
400	* @param string $taskqueue
401	* @param string $task
402	* @param int $newLeaseSeconds The new lease in seconds.
403	* @param Google_Task $postBody
404	* @param array $optParams Optional parameters.
405	* @return Google_Service_Taskqueue_Task
406	*/
407	public function update($project, $taskqueue, $task, $newLeaseSeconds, Google_Service_Taskqueue_Task $postBody, $optParams = array())
408	{
409	$params = array('project' => $project, 'taskqueue' => $taskqueue, 'task' => $task, 'newLeaseSeconds' => $newLeaseSeconds, 'postBody' => $postBody);
410	$params = array_merge($params, $optParams);
411	return $this->call('update', array($params), "Google_Service_Taskqueue_Task");
412	}
413	}
414
415
416
417
418	class Google_Service_Taskqueue_Task extends Google_Model
419	{
420	protected $internal_gapi_mappings = array(
421	"retryCount" => "retry_count",
422	);
423	public $enqueueTimestamp;
424	public $id;
425	public $kind;
426	public $leaseTimestamp;
427	public $payloadBase64;
428	public $queueName;
429	public $retryCount;
430	public $tag;
431
432
433	public function setEnqueueTimestamp($enqueueTimestamp)
434	{
435	$this->enqueueTimestamp = $enqueueTimestamp;
436	}
437	public function getEnqueueTimestamp()
438	{
439	return $this->enqueueTimestamp;
440	}
441	public function setId($id)
442	{
443	$this->id = $id;
444	}
445	public function getId()
446	{
447	return $this->id;
448	}
449	public function setKind($kind)
450	{
451	$this->kind = $kind;
452	}
453	public function getKind()
454	{
455	return $this->kind;
456	}
457	public function setLeaseTimestamp($leaseTimestamp)
458	{
459	$this->leaseTimestamp = $leaseTimestamp;
460	}
461	public function getLeaseTimestamp()
462	{
463	return $this->leaseTimestamp;
464	}
465	public function setPayloadBase64($payloadBase64)
466	{
467	$this->payloadBase64 = $payloadBase64;
468	}
469	public function getPayloadBase64()
470	{
471	return $this->payloadBase64;
472	}
473	public function setQueueName($queueName)
474	{
475	$this->queueName = $queueName;
476	}
477	public function getQueueName()
478	{
479	return $this->queueName;
480	}
481	public function setRetryCount($retryCount)
482	{
483	$this->retryCount = $retryCount;
484	}
485	public function getRetryCount()
486	{
487	return $this->retryCount;
488	}
489	public function setTag($tag)
490	{
491	$this->tag = $tag;
492	}
493	public function getTag()
494	{
495	return $this->tag;
496	}
497	}
498
499	class Google_Service_Taskqueue_TaskQueue extends Google_Model
500	{
501	protected $internal_gapi_mappings = array(
502	);
503	protected $aclType = 'Google_Service_Taskqueue_TaskQueueAcl';
504	protected $aclDataType = '';
505	public $id;
506	public $kind;
507	public $maxLeases;
508	protected $statsType = 'Google_Service_Taskqueue_TaskQueueStats';
509	protected $statsDataType = '';
510
511
512	public function setAcl(Google_Service_Taskqueue_TaskQueueAcl $acl)
513	{
514	$this->acl = $acl;
515	}
516	public function getAcl()
517	{
518	return $this->acl;
519	}
520	public function setId($id)
521	{
522	$this->id = $id;
523	}
524	public function getId()
525	{
526	return $this->id;
527	}
528	public function setKind($kind)
529	{
530	$this->kind = $kind;
531	}
532	public function getKind()
533	{
534	return $this->kind;
535	}
536	public function setMaxLeases($maxLeases)
537	{
538	$this->maxLeases = $maxLeases;
539	}
540	public function getMaxLeases()
541	{
542	return $this->maxLeases;
543	}
544	public function setStats(Google_Service_Taskqueue_TaskQueueStats $stats)
545	{
546	$this->stats = $stats;
547	}
548	public function getStats()
549	{
550	return $this->stats;
551	}
552	}
553
554	class Google_Service_Taskqueue_TaskQueueAcl extends Google_Collection
555	{
556	protected $collection_key = 'producerEmails';
557	protected $internal_gapi_mappings = array(
558	);
559	public $adminEmails;
560	public $consumerEmails;
561	public $producerEmails;
562
563
564	public function setAdminEmails($adminEmails)
565	{
566	$this->adminEmails = $adminEmails;
567	}
568	public function getAdminEmails()
569	{
570	return $this->adminEmails;
571	}
572	public function setConsumerEmails($consumerEmails)
573	{
574	$this->consumerEmails = $consumerEmails;
575	}
576	public function getConsumerEmails()
577	{
578	return $this->consumerEmails;
579	}
580	public function setProducerEmails($producerEmails)
581	{
582	$this->producerEmails = $producerEmails;
583	}
584	public function getProducerEmails()
585	{
586	return $this->producerEmails;
587	}
588	}
589
590	class Google_Service_Taskqueue_TaskQueueStats extends Google_Model
591	{
592	protected $internal_gapi_mappings = array(
593	);
594	public $leasedLastHour;
595	public $leasedLastMinute;
596	public $oldestTask;
597	public $totalTasks;
598
599
600	public function setLeasedLastHour($leasedLastHour)
601	{
602	$this->leasedLastHour = $leasedLastHour;
603	}
604	public function getLeasedLastHour()
605	{
606	return $this->leasedLastHour;
607	}
608	public function setLeasedLastMinute($leasedLastMinute)
609	{
610	$this->leasedLastMinute = $leasedLastMinute;
611	}
612	public function getLeasedLastMinute()
613	{
614	return $this->leasedLastMinute;
615	}
616	public function setOldestTask($oldestTask)
617	{
618	$this->oldestTask = $oldestTask;
619	}
620	public function getOldestTask()
621	{
622	return $this->oldestTask;
623	}
624	public function setTotalTasks($totalTasks)
625	{
626	$this->totalTasks = $totalTasks;
627	}
628	public function getTotalTasks()
629	{
630	return $this->totalTasks;
631	}
632	}
633
634	class Google_Service_Taskqueue_Tasks extends Google_Collection
635	{
636	protected $collection_key = 'items';
637	protected $internal_gapi_mappings = array(
638	);
639	protected $itemsType = 'Google_Service_Taskqueue_Task';
640	protected $itemsDataType = 'array';
641	public $kind;
642
643
644	public function setItems($items)
645	{
646	$this->items = $items;
647	}
648	public function getItems()
649	{
650	return $this->items;
651	}
652	public function setKind($kind)
653	{
654	$this->kind = $kind;
655	}
656	public function getKind()
657	{
658	return $this->kind;
659	}
660	}
661
662	class Google_Service_Taskqueue_Tasks2 extends Google_Collection
663	{
664	protected $collection_key = 'items';
665	protected $internal_gapi_mappings = array(
666	);
667	protected $itemsType = 'Google_Service_Taskqueue_Task';
668	protected $itemsDataType = 'array';
669	public $kind;
670
671
672	public function setItems($items)
673	{
674	$this->items = $items;
675	}
676	public function getItems()
677	{
678	return $this->items;
679	}
680	public function setKind($kind)
681	{
682	$this->kind = $kind;
683	}
684	public function getKind()
685	{
686	return $this->kind;
687	}
688	}
689