Cloud Tasks client libraries

Stay organized with collections Save and categorize content based on your preferences.

This page shows how to get started with the Google Cloud client libraries for the Cloud Tasks API. Read more about the client libraries for Cloud APIs in Client libraries explained.

Installing the client library

C#

For more information, see Setting Up a C# Development Environment.

Install-Package Google.Cloud.Tasks.V2 -Version 1.0.0

Go

For more information, see Setting Up Your Development Environment.

go get cloud.google.com/go/cloudtasks

Java

For more information, see Setting Up a Java Development Environment.

If you are using Maven, add the following to your pom.xml file:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-tasks</artifactId>
  <version>1.29.1</version>
</dependency>

If you are using Gradle, add the following to your dependencies:

compile 'com.google.cloud:google-cloud-tasks:1.29.1'

If you are using SBT, add the following to your dependencies:

libraryDependencies += "com.google.cloud" % "google-cloud-tasks" % "1.29.1"

If you are using VS Code, IntelliJ or Eclipse, you can add client libraries to your project using the following IDE plugins:

The plugins provide additional functionality, such as key management for service accounts. Refer to each plugin's documentation for details.

Node.js

For more information, see Setting Up a Node.js Development Environment.

npm install --save @google-cloud/tasks

PHP 

composer require google/cloud-tasks

Python

For more information, see Setting Up a Python Development Environment.

pip install --upgrade google-cloud-tasks

Ruby

For more information, see Setting Up a Ruby Development Environment.

gem install google-cloud-tasks

Setting up authentication for use with the client library

To run the client library, you must first set up authentication by creating a service account with its key, and then setting an environment variable to point to that key. For more information, see the GCP authentication documentation .

Console

Create a service account:

  1. In the Google Cloud console, go to the Create service account page.

    Go to Create service account
  2. Select your project.

  3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

    In the Service account description field, enter a description. For example, Service account for quickstart.

  4. Click Create and continue.

  5. To provide access to your project, grant the following role(s) to your service account: Project > Owner.

    In the Select a role list, select a role.

    For additional roles, click Add another role and add each additional role.

  6. Click Continue.

  7. Click Done to finish creating the service account.

    Do not close your browser window. You will use it in the next step.

Create a service account key:

  1. In the Google Cloud console, click the email address for the service account that you created.
  2. Click Keys.
  3. Click Add key, and then click Create new key.
  4. Click Create. A JSON key file is downloaded to your computer.
  5. Click Close.

gcloud

Set up authentication:

  1. Create the service account: 

    gcloud iam service-accounts create NAME

    Replace NAME with a name for the service account.

  2. Grant roles to the service account. Run the following command once for each of the following IAM roles: roles/owner: 

    gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE

    Replace the following:

    • SERVICE_ACCOUNT_NAME: the name of the service account
    • PROJECT_ID: the project ID where you created the service account
    • ROLE: the role to grant

  3. Generate the key file: 

    gcloud iam service-accounts keys create FILE_NAME.json --iam-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

    Replace the following:

    • FILE_NAME: a name for the key file
    • SERVICE_ACCOUNT_NAME: the name of the service account
    • PROJECT_ID: the project ID where you created the service account

Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to the path of the JSON file that contains your service account key. This variable only applies to your current shell session, so if you open a new session, set the variable again.

Using the client library

For examples of using the client library, see Creating HTTP Target Tasks or Creating App Engine Tasks

Additional resources

C#

Go

Java

Node.js

PHP

Python

Ruby