Documentation

Google_Service_Taskqueue_Resource_Tasks extends Google_Service_Resource
in package

Application

The "tasks" collection of methods.

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

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Delete a task from a TaskQueue. (tasks.delete)
get() : Google_Service_Taskqueue_Task: Get a particular task from a TaskQueue. (tasks.get)
insert() : Google_Service_Taskqueue_Task: Insert a new task in a TaskQueue (tasks.insert)
lease() : Google_Service_Taskqueue_Tasks: Lease 1 or more tasks from a TaskQueue. (tasks.lease)
listTasks() : Google_Service_Taskqueue_Tasks2: List Tasks in a TaskQueue (tasks.listTasks)
patch() : Google_Service_Taskqueue_Task: Update tasks that are leased out of a TaskQueue. This method supports patch semantics. (tasks.patch)
update() : Google_Service_Taskqueue_Task: Update tasks that are leased out of a TaskQueue. (tasks.update)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Delete a task from a TaskQueue. (tasks.delete)


    public
                delete(string $project, string $taskqueue, string $task[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$project : string: The project under which the queue lies.
$taskqueue : string: The taskqueue to delete a task from.
$task : string: The id of the task to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

Get a particular task from a TaskQueue. (tasks.get)


    public
                get(string $project, string $taskqueue, string $task[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Taskqueue_Task

Parameters

$project : string: The project under which the queue lies.
$taskqueue : string: The taskqueue in which the task belongs.
$task : string: The task to get properties of.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Taskqueue_Task —

insert()

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


    public
                insert(string $project, string $taskqueue, Google_Service_Taskqueue_Task $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Taskqueue_Task

Parameters

$project : string: The project under which the queue lies
$taskqueue : string: The taskqueue to insert the task into
$postBody : Google_Service_Taskqueue_Task
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Taskqueue_Task —

lease()

Lease 1 or more tasks from a TaskQueue. (tasks.lease)


    public
                lease(string $project, string $taskqueue, int $numTasks, int $leaseSecs[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Taskqueue_Tasks

Parameters

$project : string: The project under which the queue lies.
$taskqueue : string: The taskqueue to lease a task from.
$numTasks : int: The number of tasks to lease.
$leaseSecs : int: The lease in seconds.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Taskqueue_Tasks —

listTasks()

List Tasks in a TaskQueue (tasks.listTasks)


    public
                listTasks(string $project, string $taskqueue[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Taskqueue_Tasks2

Parameters

$project : string: The project under which the queue lies.
$taskqueue : string: The id of the taskqueue to list tasks from.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Taskqueue_Tasks2 —

patch()

Update tasks that are leased out of a TaskQueue. This method supports patch semantics. (tasks.patch)


    public
                patch(string $project, string $taskqueue, string $task, int $newLeaseSeconds, Google_Service_Taskqueue_Task $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Taskqueue_Task

Parameters

$project : string: The project under which the queue lies.
$taskqueue : string
$task : string
$newLeaseSeconds : int: The new lease in seconds.
$postBody : Google_Service_Taskqueue_Task
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Taskqueue_Task —

update()

Update tasks that are leased out of a TaskQueue. (tasks.update)


    public
                update(string $project, string $taskqueue, string $task, int $newLeaseSeconds, Google_Service_Taskqueue_Task $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Taskqueue_Task

Parameters

$project : string: The project under which the queue lies.
$taskqueue : string
$task : string
$newLeaseSeconds : int: The new lease in seconds.
$postBody : Google_Service_Taskqueue_Task
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Taskqueue_Task —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —