Method: projects.locations.queues.patch

HTTP request
Path parameters
Query parameters
Request body
Response body
Authorization scopes
Try it!

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 before using this method.

HTTP request

PATCH https://cloudtasks.googleapis.com/v2beta3/{queue.name=projects/*/locations/*/queues/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`queue.name`	`string` Caller-specified and required in `queues.create`, 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 `LOCATION_ID` is the canonical ID for the queue's location. The list of available locations can be obtained by calling `locations.list`. 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.

queue.name

string

Caller-specified and required in queues.create, 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
LOCATION_ID is the canonical ID for the queue's location. The list of available locations can be obtained by calling locations.list. 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.

Query parameters

Parameters

Parameters
`updateMask`	`string (FieldMask format)` A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated. This is a comma-separated list of fully qualified names of fields. Example: `"user.displayName,photo"`.

updateMask

string (FieldMask format)

A mask used to specify which fields of the queue are being updated.

If empty, then all fields will be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Queue.

Response body

If successful, the response body contains an instance of Queue.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/cloud-tasks

For more information, see the Authentication Overview.