Constructor
new CloudTasksClient(optionsopt)
Construct an instance of CloudTasksClient.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. See the subsequent parameters for more details. Properties
|
- Source:
Members
(static) apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
- Source:
(static) port
The port for this API service.
- Source:
(static) scopes
The scopes needed to make gRPC calls for every method defined in this service.
- Source:
(static) servicePath
The DNS address for this API service.
- Source:
Methods
createQueue(request, optionsopt, callbackopt) → {Promise}
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 before using
this method.
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
|||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Queue. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
const queue = {};
const request = {
parent: formattedParent,
queue: queue,
};
client.createQueue(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});createTask(request, optionsopt, callbackopt) → {Promise}
Creates a task and adds it to a queue.
Tasks cannot be updated after creation; there is no UpdateTask command.
- The maximum task size is 100KB.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Task. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedParent = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
const task = {};
const request = {
parent: formattedParent,
task: task,
};
client.createTask(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});deleteQueue(request, optionsopt, callbackopt) → {Promise}
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 before using
this method.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedName = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.deleteQueue({name: formattedName}).catch(err => {
console.error(err);
});deleteTask(request, optionsopt, callbackopt) → {Promise}
Deletes a task.
A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedName = client.taskPath('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]');
client.deleteTask({name: formattedName}).catch(err => {
console.error(err);
});getIamPolicy(request, optionsopt, callbackopt) → {Promise}
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 permission on the specified resource parent:
cloudtasks.queues.getIamPolicy
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Policy. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedResource = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.getIamPolicy({resource: formattedResource})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});getProjectId(callback)
Return the project ID used by this class.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function |
the callback to be called with the current project Id. |
- Source:
getQueue(request, optionsopt, callbackopt) → {Promise}
Gets a queue.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Queue. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedName = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.getQueue({name: formattedName})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});getTask(request, optionsopt, callbackopt) → {Promise}
Gets a task.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Task. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedName = client.taskPath('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]');
client.getTask({name: formattedName})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});listQueues(request, optionsopt, callbackopt) → {Promise}
Lists queues.
Queues are returned in lexicographical order.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is Array of Queue. When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListQueuesResponse. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
// Iterate over all elements.
const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
client.listQueues({parent: formattedParent})
.then(responses => {
const resources = responses[0];
for (const resource of resources) {
// doThingsWith(resource)
}
})
.catch(err => {
console.error(err);
});
// Or obtain the paged response.
const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
const options = {autoPaginate: false};
const callback = responses => {
// The actual resources in a response.
const resources = responses[0];
// The next request if the response shows that there are more responses.
const nextRequest = responses[1];
// The actual response object, if necessary.
// const rawResponse = responses[2];
for (const resource of resources) {
// doThingsWith(resource);
}
if (nextRequest) {
// Fetch the next page.
return client.listQueues(nextRequest, options).then(callback);
}
}
client.listQueues({parent: formattedParent}, options)
.then(callback)
.catch(err => {
console.error(err);
});listQueuesStream(request, optionsopt) → {Stream}
Equivalent to listQueues, but returns a NodeJS Stream object.
This fetches the paged responses for listQueues continuously and invokes the callback registered for 'data' event for each element in the responses.
The returned object has 'end' method when no more elements are required.
autoPaginate option will be ignored.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
client.listQueuesStream({parent: formattedParent})
.on('data', element => {
// doThingsWith(element)
}).on('error', err => {
console.log(err);
});listTasks(request, optionsopt, callbackopt) → {Promise}
Lists the tasks in a queue.
By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned.
The tasks may be returned in any order. The ordering may change at any time.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is Array of Task. When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListTasksResponse. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
// Iterate over all elements.
const formattedParent = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.listTasks({parent: formattedParent})
.then(responses => {
const resources = responses[0];
for (const resource of resources) {
// doThingsWith(resource)
}
})
.catch(err => {
console.error(err);
});
// Or obtain the paged response.
const formattedParent = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
const options = {autoPaginate: false};
const callback = responses => {
// The actual resources in a response.
const resources = responses[0];
// The next request if the response shows that there are more responses.
const nextRequest = responses[1];
// The actual response object, if necessary.
// const rawResponse = responses[2];
for (const resource of resources) {
// doThingsWith(resource);
}
if (nextRequest) {
// Fetch the next page.
return client.listTasks(nextRequest, options).then(callback);
}
}
client.listTasks({parent: formattedParent}, options)
.then(callback)
.catch(err => {
console.error(err);
});listTasksStream(request, optionsopt) → {Stream}
Equivalent to listTasks, but returns a NodeJS Stream object.
This fetches the paged responses for listTasks continuously and invokes the callback registered for 'data' event for each element in the responses.
The returned object has 'end' method when no more elements are required.
autoPaginate option will be ignored.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedParent = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.listTasksStream({parent: formattedParent})
.on('data', element => {
// doThingsWith(element)
}).on('error', err => {
console.log(err);
});locationPath(project, location) → {String}
Return a fully-qualified location resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
String | |
location |
String |
- Source:
matchLocationFromLocationName(locationName) → {String}
Parse the locationName from a location resource.
Parameters:
| Name | Type | Description |
|---|---|---|
locationName |
String |
A fully-qualified path representing a location resources. |
- Source:
matchLocationFromQueueName(queueName) → {String}
Parse the queueName from a queue resource.
Parameters:
| Name | Type | Description |
|---|---|---|
queueName |
String |
A fully-qualified path representing a queue resources. |
- Source:
matchLocationFromTaskName(taskName) → {String}
Parse the taskName from a task resource.
Parameters:
| Name | Type | Description |
|---|---|---|
taskName |
String |
A fully-qualified path representing a task resources. |
- Source:
matchProjectFromLocationName(locationName) → {String}
Parse the locationName from a location resource.
Parameters:
| Name | Type | Description |
|---|---|---|
locationName |
String |
A fully-qualified path representing a location resources. |
- Source:
matchProjectFromProjectName(projectName) → {String}
Parse the projectName from a project resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectName |
String |
A fully-qualified path representing a project resources. |
- Source:
matchProjectFromQueueName(queueName) → {String}
Parse the queueName from a queue resource.
Parameters:
| Name | Type | Description |
|---|---|---|
queueName |
String |
A fully-qualified path representing a queue resources. |
- Source:
matchProjectFromTaskName(taskName) → {String}
Parse the taskName from a task resource.
Parameters:
| Name | Type | Description |
|---|---|---|
taskName |
String |
A fully-qualified path representing a task resources. |
- Source:
matchQueueFromQueueName(queueName) → {String}
Parse the queueName from a queue resource.
Parameters:
| Name | Type | Description |
|---|---|---|
queueName |
String |
A fully-qualified path representing a queue resources. |
- Source:
matchQueueFromTaskName(taskName) → {String}
Parse the taskName from a task resource.
Parameters:
| Name | Type | Description |
|---|---|---|
taskName |
String |
A fully-qualified path representing a task resources. |
- Source:
matchTaskFromTaskName(taskName) → {String}
Parse the taskName from a task resource.
Parameters:
| Name | Type | Description |
|---|---|---|
taskName |
String |
A fully-qualified path representing a task resources. |
- Source:
pauseQueue(request, optionsopt, callbackopt) → {Promise}
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.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Queue. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedName = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.pauseQueue({name: formattedName})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});projectPath(project) → {String}
Return a fully-qualified project resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
String |
- Source:
purgeQueue(request, optionsopt, callbackopt) → {Promise}
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.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Queue. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedName = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.purgeQueue({name: formattedName})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});queuePath(project, location, queue) → {String}
Return a fully-qualified queue resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
String | |
location |
String | |
queue |
String |
- Source:
resumeQueue(request, optionsopt, callbackopt) → {Promise}
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.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Queue. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedName = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.resumeQueue({name: formattedName})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});runTask(request, optionsopt, callbackopt) → {Promise}
Forces a task to run now.
When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED.
This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now.
The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target.
If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig.
RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Task. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedName = client.taskPath('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]');
client.runTask({name: formattedName})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});setIamPolicy(request, optionsopt, callbackopt) → {Promise}
Sets the access control policy for a Queue. Replaces any existing 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
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
|||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Policy. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedResource = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
const policy = {};
const request = {
resource: formattedResource,
policy: policy,
};
client.setIamPolicy(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});taskPath(project, location, queue, task) → {String}
Return a fully-qualified task resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
String | |
location |
String | |
queue |
String | |
task |
String |
- Source:
testIamPermissions(request, optionsopt, callbackopt) → {Promise}
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.
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.
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
|||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing TestIamPermissionsResponse. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const formattedResource = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
const permissions = [];
const request = {
resource: formattedResource,
permissions: permissions,
};
client.testIamPermissions(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});updateQueue(request, optionsopt, callbackopt) → {Promise}
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.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing Queue. |
- Source:
Example
const tasks = require('tasks.v2beta3');
const client = new tasks.v2beta3.CloudTasksClient({
// optional auth parameters.
});
const queue = {};
client.updateQueue({queue: queue})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});