Google_Service_Taskqueue_Tasks_Resource Class Reference

The "tasks" collection of methods. More...

Inheritance diagram for Google_Service_Taskqueue_Tasks_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($project, $taskqueue, $task, $optParams=array())
	Delete a task from a TaskQueue.
	get ($project, $taskqueue, $task, $optParams=array())
	Get a particular task from a TaskQueue.
	insert ($project, $taskqueue, Google_Service_Taskqueue_Task $postBody, $optParams=array())
	Insert a new task in a TaskQueue (tasks.insert)
	lease ($project, $taskqueue, $numTasks, $leaseSecs, $optParams=array())
	Lease 1 or more tasks from a TaskQueue.
	listTasks ($project, $taskqueue, $optParams=array())
	List Tasks in a TaskQueue (tasks.listTasks)
	patch ($project, $taskqueue, $task, $newLeaseSeconds, Google_Service_Taskqueue_Task $postBody, $optParams=array())
	Update tasks that are leased out of a TaskQueue.
	update ($project, $taskqueue, $task, $newLeaseSeconds, Google_Service_Taskqueue_Task $postBody, $optParams=array())
	Update tasks that are leased out of a TaskQueue.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "tasks" collection of methods.

Typical usage is: $taskqueueService = new Google_Service_Taskqueue(...); $tasks = $taskqueueService->tasks;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

delete()

Google_Service_Taskqueue_Tasks_Resource::delete	(		$project,
			$taskqueue,
			$task,
			$optParams = array() )

Delete a task from a TaskQueue.

(tasks.delete)

Parameters

string	$project	The project under which the queue lies.
string	$taskqueue	The taskqueue to delete a task from.
string	$task	The id of the task to delete.
array	$optParams	Optional parameters.

get()

Google_Service_Taskqueue_Tasks_Resource::get	(		$project,
			$taskqueue,
			$task,
			$optParams = array() )

Get a particular task from a TaskQueue.

(tasks.get)

Parameters

string	$project	The project under which the queue lies.
string	$taskqueue	The taskqueue in which the task belongs.
string	$task	The task to get properties of.
array	$optParams	Optional parameters.

Return values

Google_Service_Taskqueue_Task

insert()

Google_Service_Taskqueue_Tasks_Resource::insert	(		$project,
			$taskqueue,
		Google_Service_Taskqueue_Task	$postBody,
			$optParams = array() )

Insert a new task in a TaskQueue (tasks.insert)

Parameters

string	$project	The project under which the queue lies
string	$taskqueue	The taskqueue to insert the task into
Google_Task	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Taskqueue_Task

lease()

Google_Service_Taskqueue_Tasks_Resource::lease	(		$project,
			$taskqueue,
			$numTasks,
			$leaseSecs,
			$optParams = array() )

Lease 1 or more tasks from a TaskQueue.

(tasks.lease)

Parameters

string	$project	The project under which the queue lies.
string	$taskqueue	The taskqueue to lease a task from.
int	$numTasks	The number of tasks to lease.
int	$leaseSecs	The lease in seconds.
array	$optParams	Optional parameters.

@opt_param bool groupByTag When true, all returned tasks will have the same tag @opt_param string tag The tag allowed for tasks in the response. Must only be specified if group_by_tag is true. If group_by_tag is true and tag is not specified the tag will be that of the oldest task by eta, i.e. the first available tag

Return values

Google_Service_Taskqueue_Tasks

listTasks()

Google_Service_Taskqueue_Tasks_Resource::listTasks	(		$project,
			$taskqueue,
			$optParams = array() )

List Tasks in a TaskQueue (tasks.listTasks)

Parameters

string	$project	The project under which the queue lies.
string	$taskqueue	The id of the taskqueue to list tasks from.
array	$optParams	Optional parameters.

Return values

Google_Service_Taskqueue_Tasks2

patch()

Google_Service_Taskqueue_Tasks_Resource::patch	(		$project,
			$taskqueue,
			$task,
			$newLeaseSeconds,
		Google_Service_Taskqueue_Task	$postBody,
			$optParams = array() )

Update tasks that are leased out of a TaskQueue.

This method supports patch semantics. (tasks.patch)

Parameters

string	$project	The project under which the queue lies.
string	$taskqueue
string	$task
int	$newLeaseSeconds	The new lease in seconds.
Google_Task	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Taskqueue_Task

update()

Google_Service_Taskqueue_Tasks_Resource::update	(		$project,
			$taskqueue,
			$task,
			$newLeaseSeconds,
		Google_Service_Taskqueue_Task	$postBody,
			$optParams = array() )

Update tasks that are leased out of a TaskQueue.

(tasks.update)

Parameters

string	$project	The project under which the queue lies.
string	$taskqueue
string	$task
int	$newLeaseSeconds	The new lease in seconds.
Google_Task	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Taskqueue_Task

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Taskqueue.php