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.
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 .
Create a service account:
In the Google Cloud console, go to the Create service account page.
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,
Grant the Project > Owner role to the service account.
To grant the role, find the Select a role list, then select
Project > Owner.
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:
Console
Service account for quickstart
.
Set up authentication:
Create the service account:
Replace
Grant the
Replace the following:
Generate the key file:
Replace the following:
gcloud
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
SERVICE_ACCOUNT_NAME
with a name for the service account.
roles/owner
IAM
role to the service account:
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=roles/owner
SERVICE_ACCOUNT_NAME
: the name of the service accountPROJECT_ID
: the project ID where you created the service accountgcloud iam service-accounts keys create FILE_NAME.json --iam-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
FILE_NAME
: a name for the key fileSERVICE_ACCOUNT_NAME
: the name of the service accountPROJECT_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 credentials.
This variable applies only 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