v2beta3.CloudTasksClient

Parameters

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

createQueue(request[, options][, callback]) → 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.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Queue. The promise has a method named "cancel" which cancels the ongoing API call.

createTask(request[, options][, callback]) → 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.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Task. The promise has a method named "cancel" which cancels the ongoing API call.

deleteQueue(request[, options][, callback]) → 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.

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);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

deleteTask(request[, options][, callback]) → 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.

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);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

getIamPolicy(request[, options][, callback]) → 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

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.

getProjectId(callback)

Return the project ID used by this class.

getQueue(request[, options][, callback]) → Promise

Gets a queue.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Queue. The promise has a method named "cancel" which cancels the ongoing API call.

getTask(request[, options][, callback]) → Promise

Gets a task.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Task. The promise has a method named "cancel" which cancels the ongoing API call.

listQueues(request[, options][, callback]) → Promise

Lists queues.

Queues are returned in lexicographical order.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of Queue.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Queue in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListQueuesResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listQueuesStream(request[, options]) → 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.

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);
  });

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing Queue on 'data' event.

listTasks(request[, options][, callback]) → 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.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of Task.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Task in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListTasksResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listTasksStream(request[, options]) → 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.

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);
  });

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing Task on 'data' event.

locationPath(project, location) → String

Return a fully-qualified location resource name string.

Returns

String 

matchLocationFromLocationName(locationName) → String

Parse the locationName from a location resource.

Returns

String 

• A string representing the location.

matchLocationFromQueueName(queueName) → String

Parse the queueName from a queue resource.

Returns

String 

• A string representing the location.

matchLocationFromTaskName(taskName) → String

Parse the taskName from a task resource.

Returns

String 

• A string representing the location.

matchProjectFromLocationName(locationName) → String

Parse the locationName from a location resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectName(projectName) → String

Parse the projectName from a project resource.

Returns

String 

• A string representing the project.

matchProjectFromQueueName(queueName) → String

Parse the queueName from a queue resource.

Returns

String 

• A string representing the project.

matchProjectFromTaskName(taskName) → String

Parse the taskName from a task resource.

Returns

String 

• A string representing the project.

matchQueueFromQueueName(queueName) → String

Parse the queueName from a queue resource.

Returns

String 

• A string representing the queue.

matchQueueFromTaskName(taskName) → String

Parse the taskName from a task resource.

Returns

String 

• A string representing the queue.

matchTaskFromTaskName(taskName) → String

Parse the taskName from a task resource.

Returns

String 

• A string representing the task.

pauseQueue(request[, options][, callback]) → 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.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Queue. The promise has a method named "cancel" which cancels the ongoing API call.

projectPath(project) → String

Return a fully-qualified project resource name string.

Returns

String 

purgeQueue(request[, options][, callback]) → 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.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Queue. The promise has a method named "cancel" which cancels the ongoing API call.

queuePath(project, location, queue) → String

Return a fully-qualified queue resource name string.

Returns

String 

resumeQueue(request[, options][, callback]) → 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.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Queue. The promise has a method named "cancel" which cancels the ongoing API call.

runTask(request[, options][, callback]) → 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.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Task. The promise has a method named "cancel" which cancels the ongoing API call.

setIamPolicy(request[, options][, callback]) → 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

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.

taskPath(project, location, queue, task) → String

Return a fully-qualified task resource name string.

Returns

String 

testIamPermissions(request[, options][, callback]) → 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.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.

updateQueue(request[, options][, callback]) → 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.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Queue. The promise has a method named "cancel" which cancels the ongoing API call.