Class v2beta3.CloudTasksClient (2.4.2)

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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 google.cloud.location.Locations.ListLocations.
   */
  // const parent = 'abc123'
  /**
   *  Required. The queue to create.
   *  Queue's name google.cloud.tasks.v2beta3.Queue.name  cannot be the same as an existing queue.
   */
  // const queue = {}

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

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

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

    // Run request
    const response = await tasksClient.createQueue(request);
    console.log(response);
  }

  callCreateQueue();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The queue name. For example:
   *  `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
   *  The queue must already exist.
   */
  // const parent = 'abc123'
  /**
   *  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 google.cloud.tasks.v2beta3.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 google.cloud.tasks.v2beta3.Task.name.
   *  If schedule_time google.cloud.tasks.v2beta3.Task.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 google.rpc.Code.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 google.cloud.tasks.v2beta3.CloudTasks.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.
   */
  // const task = {}
  /**
   *  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 = {}

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

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

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

    // Run request
    const response = await tasksClient.createTask(request);
    console.log(response);
  }

  callCreateTask();

  /**
   * 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 name = 'abc123'

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

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

  async function callDeleteQueue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await tasksClient.deleteQueue(request);
    console.log(response);
  }

  callDeleteQueue();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The task name. For example:
   *  `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
   */
  // const name = 'abc123'

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

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

  async function callDeleteTask() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await tasksClient.deleteTask(request);
    console.log(response);
  }

  callDeleteTask();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  OPTIONAL: A `GetPolicyOptions` object for specifying options to
   *  `GetIamPolicy`. This field is only used by Cloud IAM.
   */
  // const options = {}

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

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

  async function callGetIamPolicy() {
    // Construct request
    const request = {
      resource,
    };

    // Run request
    const response = await tasksClient.getIamPolicy(request);
    console.log(response);
  }

  callGetIamPolicy();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the queue. For example:
   *  `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
   */
  // const name = '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 callGetQueue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await tasksClient.getQueue(request);
    console.log(response);
  }

  callGetQueue();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The task name. For example:
   *  `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
   */
  // const name = '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 = {}

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

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

  async function callGetTask() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await tasksClient.getTask(request);
    console.log(response);
  }

  callGetTask();

  /**
   * 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();

  /**
   * 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();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The queue name. For example:
   *  `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
   */
  // const name = 'abc123'

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

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

  async function callPauseQueue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await tasksClient.pauseQueue(request);
    console.log(response);
  }

  callPauseQueue();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The queue name. For example:
   *  `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
   */
  // const name = 'abc123'

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

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

  async function callPurgeQueue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await tasksClient.purgeQueue(request);
    console.log(response);
  }

  callPurgeQueue();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The queue name. For example:
   *  `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
   */
  // const name = 'abc123'

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

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

  async function callResumeQueue() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await tasksClient.resumeQueue(request);
    console.log(response);
  }

  callResumeQueue();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The task name. For example:
   *  `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
   */
  // const name = '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 = {}

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

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

  async function callRunTask() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await tasksClient.runTask(request);
    console.log(response);
  }

  callRunTask();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy is being specified.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  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.
   */
  // const policy = {}

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

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

  async function callSetIamPolicy() {
    // Construct request
    const request = {
      resource,
      policy,
    };

    // Run request
    const response = await tasksClient.setIamPolicy(request);
    console.log(response);
  }

  callSetIamPolicy();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  REQUIRED: The resource for which the policy detail is being requested.
   *  See the operation documentation for the appropriate value for this field.
   */
  // const resource = 'abc123'
  /**
   *  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 (https://cloud.google.com/iam/docs/overview#permissions).
   */
  // const permissions = 'abc123'

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

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

  async function callTestIamPermissions() {
    // Construct request
    const request = {
      resource,
      permissions,
    };

    // Run request
    const response = await tasksClient.testIamPermissions(request);
    console.log(response);
  }

  callTestIamPermissions();