Documentation

Google_Service_CloudTasks_Resource_ProjectsLocationsQueues extends Google_Service_Resource
in package

Application

The "queues" collection of methods.

Typical usage is: $cloudtasksService = new Google_Service_CloudTasks(...); $queues = $cloudtasksService->queues;

$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.
create() : Google_Service_CloudTasks_Queue: Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. (queues.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_CloudTasks_CloudtasksEmpty: Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. (queues.delete)
get() : Google_Service_CloudTasks_Queue: Gets a queue. (queues.get)
getIamPolicy() : Google_Service_CloudTasks_Policy: Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy` (queues.getIamPolicy)
listProjectsLocationsQueues() : Google_Service_CloudTasks_ListQueuesResponse: Lists queues. Queues are returned in lexicographical order.
patch() : Google_Service_CloudTasks_Queue: Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs /queue-yaml) before using this method. (queues.patch)
pause() : Google_Service_CloudTasks_Queue: Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.
purge() : Google_Service_CloudTasks_Queue: Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible. (queues.purge)
resume() : Google_Service_CloudTasks_Queue: Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task- scaling). (queues.resume)
setIamPolicy() : Google_Service_CloudTasks_Policy: Sets the access control policy for a Queue. Replaces any existing policy.
testIamPermissions() : Google_Service_CloudTasks_TestIamPermissionsResponse: Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
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 —

create()

Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. (queues.create)


    public
                create(string $parent, Google_Service_CloudTasks_Queue $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_Queue

Parameters

$parent : string: Required. The location name in which the queue will be created. For example: projects/PROJECT_ID/locations/LOCATION_ID The list of allowed locations can be obtained by calling Cloud Tasks' implementation of ListLocations.
$postBody : Google_Service_CloudTasks_Queue
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudTasks_Queue —

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()

Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. (queues.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_CloudtasksEmpty

Parameters

$name : string: Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudTasks_CloudtasksEmpty —

get()

Gets a queue. (queues.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_Queue

Parameters

$name : string: Required. The resource name of the queue. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudTasks_Queue —

getIamPolicy()

Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy` (queues.getIamPolicy)


    public
                getIamPolicy(string $resource, Google_Service_CloudTasks_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudTasks_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudTasks_Policy —

listProjectsLocationsQueues()

Lists queues. Queues are returned in lexicographical order.


    public
                listProjectsLocationsQueues(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_ListQueuesResponse

(queues.listProjectsLocationsQueues)

Parameters

$parent : string: Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudTasks_ListQueuesResponse —

patch()

Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs /queue-yaml) before using this method. (queues.patch)


    public
                patch(string $name, Google_Service_CloudTasks_Queue $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_Queue

Parameters

$name : string

Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing- projects#identifying_projects) * LOCATION_ID is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.

$postBody : Google_Service_CloudTasks_Queue

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values

Google_Service_CloudTasks_Queue —

pause()

Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.


    public
                pause(string $name, Google_Service_CloudTasks_PauseQueueRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_Queue

(queues.pause)

Parameters

$name : string: Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
$postBody : Google_Service_CloudTasks_PauseQueueRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudTasks_Queue —

purge()

Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible. (queues.purge)


    public
                purge(string $name, Google_Service_CloudTasks_PurgeQueueRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_Queue

Parameters

$name : string: Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
$postBody : Google_Service_CloudTasks_PurgeQueueRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudTasks_Queue —

resume()

Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task- scaling). (queues.resume)


    public
                resume(string $name, Google_Service_CloudTasks_ResumeQueueRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_Queue

Parameters

$name : string: Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID
$postBody : Google_Service_CloudTasks_ResumeQueueRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudTasks_Queue —

setIamPolicy()

Sets the access control policy for a Queue. Replaces any existing policy.


    public
                setIamPolicy(string $resource, Google_Service_CloudTasks_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_Policy

Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following Google IAM permission on the specified resource parent: * cloudtasks.queues.setIamPolicy (queues.setIamPolicy)

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudTasks_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudTasks_Policy —

testIamPermissions()

Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.


    public
                testIamPermissions(string $resource, Google_Service_CloudTasks_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudTasks_TestIamPermissionsResponse

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. (queues.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudTasks_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudTasks_TestIamPermissionsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —