Constructor

CloudTasksClient

new CloudTasksClient(options)

Construct an instance of CloudTasksClient.

Parameter

options

Optional

object

The configuration object. See the subsequent parameters for more details.

Values in options have the following properties:

Parameter

credentials

Optional

object

Credentials object.

credentials.client_email

Optional

string

credentials.private_key

Optional

string

email

Optional

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

Optional

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

Optional

number

The port on which to connect to the remote host.

projectId

Optional

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

promise

Optional

function()

Custom promise module to use instead of native Promises.

servicePath

Optional

string

The domain name of the API remote host.

Properties

port

static

The port for this API service.

scopes

static

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

servicePath

static

The DNS address for this API service.

Methods

createQueue

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

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.

queue

Object

Required.

The queue to create.

Queue's name cannot be the same as an existing queue.

This object should have the same structure as Queue

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Queue.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
var queue = {};
var request = {
  parent: formattedParent,
  queue: queue,
};
client.createQueue(request)
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

createTask

createTask(request, options, callback) returns Promise

Creates a task and adds it to a queue.

Tasks cannot be updated after creation; there is no UpdateTask command.

  • For App Engine queues, the maximum task size is 100KB.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required.

The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

The queue must already exist.

task

Object

Required.

The task to add.

Task names have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID. The user can optionally specify a task name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response.

If schedule_time is not set or is in the past then Cloud Tasks will set it to the current time.

Task De-duplication:

Explicitly specifying a task ID enables task de-duplication. If a task's ID is identical to that of an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with the same name can't be created for ~9days after the original task was deleted or executed.

Because there is an extra lookup cost to identify duplicate task names, these CreateTask calls have significantly increased latency. Using hashed strings for the task id or for the prefix of the task id is recommended. Choosing task ids that are sequential or have sequential prefixes, for example using a timestamp, causes an increase in latency and error rates in all task commands. The infrastructure relies on an approximately uniform distribution of task ids to store and serve tasks efficiently.

This object should have the same structure as Task

responseView

Optional

number

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

The number should be among the values of View

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Task.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedParent = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
var task = {};
var request = {
  parent: formattedParent,
  task: task,
};
client.createTask(request)
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

deleteQueue

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error)

The function which will be called with the result of the API call.

Returns

Promise 

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

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedName = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.deleteQueue({name: formattedName}).catch(err => {
  console.error(err);
});

deleteTask

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error)

The function which will be called with the result of the API call.

Returns

Promise 

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

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedName = client.taskPath('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]');
client.deleteTask({name: formattedName}).catch(err => {
  console.error(err);
});

getIamPolicy

getIamPolicy(request, options, callback) returns 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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

resource

string

REQUIRED: The resource for which the policy is being requested. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Policy.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedResource = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.getIamPolicy({resource: formattedResource})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId

getProjectId(callback)

Return the project ID used by this class.

Parameter

callback

function(Error, string)

the callback to be called with the current project Id.

getQueue

getQueue(request, options, callback) returns Promise

Gets a queue.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The resource name of the queue. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Queue.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedName = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.getQueue({name: formattedName})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getTask

getTask(request, options, callback) returns Promise

Gets a task.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

responseView

Optional

number

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

The number should be among the values of View

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Task.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedName = client.taskPath('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]');
client.getTask({name: formattedName})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

listQueues

listQueues(request, options, callback) returns Promise

Lists queues.

Queues are returned in lexicographical order.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required.

The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID

filter

Optional

string

filter can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: <=, <, >=, >, !=, =, :. The filter syntax is the same as described in Stackdriver's Advanced Logs Filters.

Sample filter "state: PAUSED".

Note that using filters might cause fewer queues than the requested page_size to be returned.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

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.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

// Iterate over all elements.
var formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');

client.listQueues({parent: formattedParent})
  .then(responses => {
    var resources = responses[0];
    for (let i = 0; i < resources.length; i += 1) {
      // doThingsWith(resources[i])
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
var formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');


var options = {autoPaginate: false};
var callback = responses => {
  // The actual resources in a response.
  var resources = responses[0];
  // The next request if the response shows that there are more responses.
  var nextRequest = responses[1];
  // The actual response object, if necessary.
  // var rawResponse = responses[2];
  for (let i = 0; i < resources.length; i += 1) {
    // doThingsWith(resources[i]);
  }
  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

listQueuesStream(request, options) returns 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.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required.

The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID

filter

Optional

string

filter can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: <=, <, >=, >, !=, =, :. The filter syntax is the same as described in Stackdriver's Advanced Logs Filters.

Sample filter "state: PAUSED".

Note that using filters might cause fewer queues than the requested page_size to be returned.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

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

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
client.listQueuesStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listTasks

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required.

The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

responseView

Optional

number

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

The number should be among the values of View

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

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.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

// Iterate over all elements.
var formattedParent = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');

client.listTasks({parent: formattedParent})
  .then(responses => {
    var resources = responses[0];
    for (let i = 0; i < resources.length; i += 1) {
      // doThingsWith(resources[i])
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
var formattedParent = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');


var options = {autoPaginate: false};
var callback = responses => {
  // The actual resources in a response.
  var resources = responses[0];
  // The next request if the response shows that there are more responses.
  var nextRequest = responses[1];
  // The actual response object, if necessary.
  // var rawResponse = responses[2];
  for (let i = 0; i < resources.length; i += 1) {
    // doThingsWith(resources[i]);
  }
  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

listTasksStream(request, options) returns 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.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required.

The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

responseView

Optional

number

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

The number should be among the values of View

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

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

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedParent = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.listTasksStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

locationPath

locationPath(project, location) returns String

Return a fully-qualified location resource name string.

Parameter

project

String

location

String

Returns

String 

matchLocationFromLocationName

matchLocationFromLocationName(locationName) returns String

Parse the locationName from a location resource.

Parameter

locationName

String

A fully-qualified path representing a location resources.

Returns

String 

  • A string representing the location.

matchLocationFromQueueName

matchLocationFromQueueName(queueName) returns String

Parse the queueName from a queue resource.

Parameter

queueName

String

A fully-qualified path representing a queue resources.

Returns

String 

  • A string representing the location.

matchLocationFromTaskName

matchLocationFromTaskName(taskName) returns String

Parse the taskName from a task resource.

Parameter

taskName

String

A fully-qualified path representing a task resources.

Returns

String 

  • A string representing the location.

matchProjectFromLocationName

matchProjectFromLocationName(locationName) returns String

Parse the locationName from a location resource.

Parameter

locationName

String

A fully-qualified path representing a location resources.

Returns

String 

  • A string representing the project.

matchProjectFromProjectName

matchProjectFromProjectName(projectName) returns String

Parse the projectName from a project resource.

Parameter

projectName

String

A fully-qualified path representing a project resources.

Returns

String 

  • A string representing the project.

matchProjectFromQueueName

matchProjectFromQueueName(queueName) returns String

Parse the queueName from a queue resource.

Parameter

queueName

String

A fully-qualified path representing a queue resources.

Returns

String 

  • A string representing the project.

matchProjectFromTaskName

matchProjectFromTaskName(taskName) returns String

Parse the taskName from a task resource.

Parameter

taskName

String

A fully-qualified path representing a task resources.

Returns

String 

  • A string representing the project.

matchQueueFromQueueName

matchQueueFromQueueName(queueName) returns String

Parse the queueName from a queue resource.

Parameter

queueName

String

A fully-qualified path representing a queue resources.

Returns

String 

  • A string representing the queue.

matchQueueFromTaskName

matchQueueFromTaskName(taskName) returns String

Parse the taskName from a task resource.

Parameter

taskName

String

A fully-qualified path representing a task resources.

Returns

String 

  • A string representing the queue.

matchTaskFromTaskName

matchTaskFromTaskName(taskName) returns String

Parse the taskName from a task resource.

Parameter

taskName

String

A fully-qualified path representing a task resources.

Returns

String 

  • A string representing the task.

pauseQueue

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Queue.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedName = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.pauseQueue({name: formattedName})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

projectPath

projectPath(project) returns String

Return a fully-qualified project resource name string.

Parameter

project

String

Returns

String 

purgeQueue

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Queue.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedName = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.purgeQueue({name: formattedName})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

queuePath

queuePath(project, location, queue) returns String

Return a fully-qualified queue resource name string.

Parameter

project

String

location

String

queue

String

Returns

String 

resumeQueue

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Queue.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedName = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
client.resumeQueue({name: formattedName})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

runTask

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

responseView

Optional

number

The response_view specifies which subset of the Task will be returned.

By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

Authorization for FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task resource.

The number should be among the values of View

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Task.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedName = client.taskPath('[PROJECT]', '[LOCATION]', '[QUEUE]', '[TASK]');
client.runTask({name: formattedName})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

setIamPolicy

setIamPolicy(request, options, callback) returns 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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

resource

string

REQUIRED: The resource for which the policy is being specified. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

policy

Object

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

This object should have the same structure as Policy

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Policy.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedResource = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
var policy = {};
var request = {
  resource: formattedResource,
  policy: policy,
};
client.setIamPolicy(request)
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

taskPath

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

Return a fully-qualified task resource name string.

Parameter

project

String

location

String

queue

String

task

String

Returns

String 

testIamPermissions

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

resource

string

REQUIRED: The resource for which the policy detail is being requested. resource is usually specified as a path. For example, a Project resource is specified as projects/{project}.

permissions

Array of string

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var formattedResource = client.queuePath('[PROJECT]', '[LOCATION]', '[QUEUE]');
var permissions = [];
var request = {
  resource: formattedResource,
  permissions: permissions,
};
client.testIamPermissions(request)
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

updateQueue

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

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

queue

Object

Required.

The queue to create or update.

The queue's name must be specified.

Output only fields cannot be modified using UpdateQueue. Any value specified for an output only field will be ignored. The queue's name cannot be changed.

This object should have the same structure as Queue

updateMask

Optional

Object

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

If empty, then all fields will be updated.

This object should have the same structure as FieldMask

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Queue.

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.

Example

const tasks = require('tasks.v2beta3');

var client = new tasks.v2beta3.CloudTasksClient({
  // optional auth parameters.
});

var queue = {};
client.updateQueue({queue: queue})
  .then(responses => {
    var response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });