Cloud Tasks Client Libraries

This page shows how to get started with the 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 -u cloud.google.com/go/tasks

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 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 .

GCP CONSOLE

  1. In the Cloud Console, go to the Create service account key page.

    Go to Create Service Account Key

  2. From the Service account drop-down list, select New service account.
  3. In the Service account name field, enter a name .
  4. From the Role drop-down list, select Project > Owner.
  5. Click Create. A JSON file that contains your key downloads to your computer.

COMMAND LINE

You can run the following commands using the Cloud SDK on your local machine, or within Cloud Shell.

  1. Create the service account. Replace [NAME] with your desired service account name.

    gcloud iam service-accounts create [NAME]

  2. Grant permissions to the service account. Replace [PROJECT_ID] with your project ID.

    gcloud projects add-iam-policy-binding [PROJECT_ID] --member
"serviceAccount: [NAME]@[PROJECT_ID].iam.gserviceaccount.com" --role
"roles/owner"

  3. Generate the key file. Replace [FILE_NAME] with a name for the key file.

    gcloud iam service-accounts keys create [FILE_NAME].json --iam-account
[NAME]@[PROJECT_ID].iam.gserviceaccount.com

Provide authentication credentials (the downloaded key) to your application code by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS to point to the file where you stored the key. Replace [PATH] with the file path of the JSON file that contains your service account key, and [FILE_NAME] with the filename. This variable only applies to your current shell session, so if you open a new session, set the variable again.

LINUX OR MACOS 

export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

For example:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/[FILE_NAME].json"

WINDOWS

With PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

For example:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\[FILE_NAME].json"

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