This page shows how to get started with the Cloud Client Libraries for the Pub/Sub Lite API. Read more about the client libraries for Cloud APIs in Client Libraries Explained.
Installing the client library
For more information, see Setting Up a Java Development Environment.
<dependency> <groupId>com.google.cloud</groupId> <artifactId>google-cloud-pubsublite</artifactId> <version>0.1.7</version> </dependency> <dependency> <groupId>com.google.cloud</groupId> <artifactId>google-cloud-pubsub</artifactId> <version>1.107.0</version> </dependency> <!-- A logging dependency used by the underlying library --> <dependency> <groupId>com.google.flogger</groupId> <artifactId>flogger-system-backend</artifactId> <version>0.5.1</version> <scope>runtime</scope> </dependency>
If you are using Gradle, add the following to your dependencies:
If you are using sbt, add the following to your dependencies:
libraryDependencies += "com.google.cloud" % "google-cloud-pubsublite" % "0.1.7"
If you're 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.
Setting up authentication
To run the client library, you must first set up authentication by creating a service account and setting an environment variable. Complete the following steps to set up authentication. For other ways to authenticate, see the GCP authentication documentation.
In the Cloud Console, go to the Create service account key page.Go to the Create Service Account Key page
- From the Service account list, select New service account.
- In the Service account name field, enter a name.
From the Role list, select Project > Owner.Note: The Role field authorizes your service account to access resources. You can view and change this field later by using the Cloud Console. If you are developing a production app, specify more granular permissions than Project > Owner. For more information, see granting roles to service accounts.
- Click Create. A JSON file that contains your key downloads to your computer.
Create the service account. Replace [NAME] with a name for the service account.
gcloud iam service-accounts create [NAME]
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"
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 to your application code by
setting the environment variable
Replace [PATH] with the file 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.
Linux or macOS
With command prompt: