CloudTasksClient

Cloud Tasks allows developers to manage the execution of background work in their applications.

Constructor

new CloudTasksClient(optionsopt, gaxInstanceopt)

Construct an instance of CloudTasksClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

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

keyFilename

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

number

The port on which to connect to the remote host.

projectId

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.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean | "rest"

Use HTTP fallback mode. Pass "rest" to use HTTP/1.1 REST API instead of gRPC. For more information, please check the documentation.

gaxInstance

gax

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new CloudTasksClient({fallback: 'rest'}, gax);

Members

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.

Methods

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

listQueuesAsync(request, optionsopt) → {Object}

Equivalent to listQueues, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`
`filter`	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`	number		Requested page size. The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.
`pageToken`	string		A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.
`readMask`	google.protobuf.FieldMask	<optional>	Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Queue. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location name.
   *  For example: `projects/PROJECT_ID/locations/LOCATION_ID`
   */
  // const parent = 'abc123'
  /**
   *  `filter` can be used to specify a subset of queues. Any Queue google.cloud.tasks.v2beta3.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 (https://cloud.google.com/logging/docs/view/advanced_filters).
   *  Sample filter "state: PAUSED".
   *  Note that using filters might cause fewer queues than the
   *  requested page_size to be returned.
   */
  // const filter = 'abc123'
  /**
   *  Requested page size.
   *  The maximum page size is 9800. If unspecified, the page size will
   *  be the maximum. Fewer queues than requested might be returned,
   *  even if more queues exist; use the
   *  next_page_token google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token  in the
   *  response to determine if more queues exist.
   */
  // const pageSize = 1234
  /**
   *  A token identifying the page of results to return.
   *  To request the first page results, page_token must be empty. To
   *  request the next page of results, page_token must be the value of
   *  next_page_token google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token  returned
   *  from the previous call to ListQueues google.cloud.tasks.v2beta3.CloudTasks.ListQueues 
   *  method. It is an error to switch the value of the
   *  filter google.cloud.tasks.v2beta3.ListQueuesRequest.filter  while iterating through pages.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Read mask is used for a more granular control over what the API returns.
   *  If the mask is not present all fields will be returned except
   *  Queue.stats. Queue.stats will be returned only if it was  explicitly
   *  specified in the mask.
   */
  // const readMask = {}

  // Imports the Tasks library
  const {CloudTasksClient} = require('@google-cloud/tasks').v2beta3;

  // Instantiates a client
  const tasksClient = new CloudTasksClient();

  async function callListQueues() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await tasksClient.listQueuesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListQueues();

listQueuesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`
`filter`	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`	number		Requested page size. The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.
`pageToken`	string		A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.
`readMask`	google.protobuf.FieldMask	<optional>	Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Queue on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listQueuesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listTasksAsync(request, optionsopt) → {Object}

Equivalent to listTasks, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
`responseView`	google.cloud.tasks.v2beta3.Task.View	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.
`pageSize`	number	Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. The maximum page size is 1000. If unspecified, the page size will be the maximum.
`pageToken`	string	A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Task. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The queue name. For example:
   *  `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
   */
  // const parent = 'abc123'
  /**
   *  The response_view specifies which subset of the Task google.cloud.tasks.v2beta3.Task  will be
   *  returned.
   *  By default response_view is BASIC google.cloud.tasks.v2beta3.Task.View.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 google.cloud.tasks.v2beta3.Task.View.FULL  requires
   *  `cloudtasks.tasks.fullView` Google IAM (https://cloud.google.com/iam/)
   *  permission on the Task google.cloud.tasks.v2beta3.Task  resource.
   */
  // const responseView = {}
  /**
   *  Maximum page size.
   *  Fewer tasks than requested might be returned, even if more tasks exist; use
   *  next_page_token google.cloud.tasks.v2beta3.ListTasksResponse.next_page_token  in the response to
   *  determine if more tasks exist.
   *  The maximum page size is 1000. If unspecified, the page size will be the
   *  maximum.
   */
  // const pageSize = 1234
  /**
   *  A token identifying the page of results to return.
   *  To request the first page results, page_token must be empty. To
   *  request the next page of results, page_token must be the value of
   *  next_page_token google.cloud.tasks.v2beta3.ListTasksResponse.next_page_token  returned
   *  from the previous call to ListTasks google.cloud.tasks.v2beta3.CloudTasks.ListTasks 
   *  method.
   *  The page token is valid for only 2 hours.
   */
  // const pageToken = 'abc123'

  // Imports the Tasks library
  const {CloudTasksClient} = require('@google-cloud/tasks').v2beta3;

  // Instantiates a client
  const tasksClient = new CloudTasksClient();

  async function callListTasks() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await tasksClient.listTasksAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListTasks();

listTasksStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
`responseView`	google.cloud.tasks.v2beta3.Task.View	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.
`pageSize`	number	Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. The maximum page size is 1000. If unspecified, the page size will be the maximum.
`pageToken`	string	A token identifying the page of results to return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Task on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listTasksAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromQueueName(queueName) → {string}

Parse the location from Queue resource.

Parameters:

Name	Type	Description
`queueName`	string	A fully-qualified path representing Queue resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromTaskName(taskName) → {string}

Parse the location from Task resource.

Parameters:

Name	Type	Description
`taskName`	string	A fully-qualified path representing Task resource.

Returns:

Type	Description
string	A string representing the location.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:

Name	Type	Description
`locationName`	string	A fully-qualified path representing Location resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:

Name	Type	Description
`projectName`	string	A fully-qualified path representing Project resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromQueueName(queueName) → {string}

Parse the project from Queue resource.

Parameters:

Name	Type	Description
`queueName`	string	A fully-qualified path representing Queue resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromTaskName(taskName) → {string}

Parse the project from Task resource.

Parameters:

Name	Type	Description
`taskName`	string	A fully-qualified path representing Task resource.

Returns:

Type	Description
string	A string representing the project.

matchQueueFromQueueName(queueName) → {string}

Parse the queue from Queue resource.

Parameters:

Name	Type	Description
`queueName`	string	A fully-qualified path representing Queue resource.

Returns:

Type	Description
string	A string representing the queue.

matchQueueFromTaskName(taskName) → {string}

Parse the queue from Task resource.

Parameters:

Name	Type	Description
`taskName`	string	A fully-qualified path representing Task resource.

Returns:

Type	Description
string	A string representing the queue.

matchTaskFromTaskName(taskName) → {string}

Parse the task from Task resource.

Parameters:

Name	Type	Description
`taskName`	string	A fully-qualified path representing Task resource.

Returns:

Type	Description
string	A string representing the task.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

queuePath(project, location, queue) → {string}

Return a fully-qualified queue resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`queue`	string

Returns:

Type	Description
string	Resource name string.

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

Returns:

Type	Description
string	Resource name string.