This page shows how to get started with the Cloud Client Libraries for the Compute Engine API. Client libraries make it easier to access Google Cloud APIs from a supported language. Although you can use Google Cloud APIs directly by making raw requests to the server, client libraries provide simplifications that significantly reduce the amount of code you need to write.
Read more about the Cloud Client Libraries and the older Google API Client Libraries in Client libraries explained.
To follow step-by-step guidance for this task directly in the Google Cloud console, click Guide me:
Install the client library
C++
Follow the
Quickstart.
C#
Install the
Google.Cloud.Compute.V1
package from NuGet.
For more information, see Setting Up a C# Development Environment.
Go
go get cloud.google.com/go/compute/apiv1
For more information, see Setting Up a Go Development Environment.
Java
If you are using Maven, add
the following to your pom.xml file. For more information about
BOMs, see The Google Cloud Platform Libraries BOM.
If you are using Gradle, add the following to your dependencies:
If you are using sbt, add the following to your dependencies:
The older version of the Cloud Client Libraries for Java for Compute Engine is available as version 0.120.x or earlier in the Maven artifact. Versions 0.120.x and earlier of this library are forward-incompatible with later versions.
For more information, see Setting Up a Java Development Environment.
Node.js
npm install @google-cloud/compute
The older version of the Cloud Client Libraries for Node.js for Compute Engine is available as version 2.5.x or earlier in the npm package. Versions 2.5.x and earlier of this library are forward-incompatible with later versions.
For more information, see Setting Up a Node.js Development Environment.
PHP
composer require google/cloud-compute
For more information, see Using PHP on Google Cloud.
Python
pip install --upgrade google-cloud-compute
For more information, see Setting Up a Python Development Environment.
Ruby
gem install google-cloud-compute-v1
For more information, see Setting Up a Ruby Development Environment.
Rust
cargo add google-cloud-compute-v1
For more information, see Get started with Rust.
Set up authentication
To authenticate calls to Google Cloud APIs, client libraries support Application Default Credentials (ADC); the libraries look for credentials in a set of defined locations and use those credentials to authenticate requests to the API. With ADC, you can make credentials available to your application in a variety of environments, such as local development or production, without needing to modify your application code.For production environments, the way you set up ADC depends on the service and context. For more information, see Set up Application Default Credentials.
For a local development environment, you can set up ADC with the credentials that are associated with your Google Account:
-
Install the Google Cloud CLI. After installation, initialize the Google Cloud CLI by running the following command:
gcloud initIf you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
If you're using a local shell, then create local authentication credentials for your user account:
gcloud auth application-default login
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC.
Use the client library
The following example shows how to use the client library to list instances in a particular zone. For more examples, see Using client libraries.