Java idiomatic client for Google Cloud Compute.
Note: This client is no longer receiving updates; new features in the Compute API will not be added to this client. Check https://cloud.google.com/compute/docs/api/libraries for the recommended Java client library to use for accessing Compute.
If you are using Maven, add this to your pom.xml file
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-compute</artifactId>
<version>0.48.0-alpha</version>
</dependency>If you are using Gradle, add this to your dependencies
compile 'com.google.cloud:google-cloud-compute:0.48.0-alpha'If you are using SBT, add this to your dependencies
libraryDependencies += "com.google.cloud" % "google-cloud-compute" % "0.48.0-alpha"ComputeExample
is a simple command line interface that provides some of Google Cloud Compute Engine's
functionality. Read more about using the application on the
ComputeExample docs page.
See the Authentication section in the base directory's README.
Google Cloud Compute delivers virtual machines running in Google's innovative data centers and worldwide fiber network. Compute Engine's tooling and workflow support enable scaling from single instances to global, load-balanced cloud computing. Compute Engine's VMs boot quickly, come with persistent disk storage, deliver consistent performance and are available in many configurations.
Be sure to activate the Google Cloud Compute API on the Developer's Console to use Compute from your project.
See the Compute client library docs to learn how to interact with Google Cloud Compute using this Client Library.
For this tutorial, you will need a Google Developers Console
project with the Compute Engine API enabled. You will need to enable billing
to use Google Cloud DNS. Follow these instructions
to get your project set up. You will also need to set up the local development environment by
installing the Google Cloud SDK and running the following commands
in command line: gcloud auth login and gcloud config set project [YOUR PROJECT ID].
You'll need to obtain the google-cloud-compute library. See the Quickstart section
to add google-cloud-compute as a dependency in your code.
To make authenticated requests to Google Cloud Compute Engine, you must create a service object with credentials. You can then make API calls by calling methods on the Compute service object. The simplest way to authenticate is to use Application Default Credentials. These credentials are automatically inferred from your environment, so you only need the following code to create your service object:
import com.google.cloud.compute.deprecated.Compute;
import com.google.cloud.compute.deprecated.ComputeOptions;
Compute compute = ComputeOptions.getDefaultInstance().getService();For other authentication options, see the Authentication page.
An external region IP address can be associated to a Google Compute Engine instance to communicate with instances in different regions or to communicate with the instance from ouside of Compute Engine. In this code snippet, we will create a new external region address.
Add the following imports at the top of your file:
import com.google.cloud.compute.deprecated.AddressInfo;
import com.google.cloud.compute.deprecated.Operation;
import com.google.cloud.compute.deprecated.RegionAddressId;Then add the following code to create an address. Most Compute Engine calls return an Operation
object that can be used to wait for operation completion and to check whether operation failed or
succeeded:
RegionAddressId addressId = RegionAddressId.of("us-central1", "test-address");
Operation operation = compute.create(AddressInfo.of(addressId));
// Wait for operation to complete
operation = operation.waitFor();
if (operation.getErrors() == null) {
System.out.println("Address " + addressId + " was successfully created");
} else {
// inspect operation.getErrors()
throw new RuntimeException("Address creation failed");
}A persistent disk can be used as primary storage for your virtual machine instances. Persistent disks can be created empty, from a disk image or from a disk snapshot. Compute Engine offers publicly-available images of certain operating systems that you can use. In this code snippet, we will create a new persistent disk from a publicly-available image.
Add the following imports at the top of your file:
import com.google.cloud.compute.deprecated.DiskInfo;
import com.google.cloud.compute.deprecated.DiskId;
import com.google.cloud.compute.deprecated.ImageDiskConfiguration;
import com.google.cloud.compute.deprecated.ImageId;Then add the following code to create a disk and wait for disk creation to terminate.
ImageId imageId = ImageId.of("debian-cloud", "debian-8-jessie-v20160329");
DiskId diskId = DiskId.of("us-central1-a", "test-disk");
ImageDiskConfiguration diskConfiguration = ImageDiskConfiguration.of(imageId);
DiskInfo disk = DiskInfo.of(diskId, diskConfiguration);
Operation operation = compute.create(disk);
// Wait for operation to complete
operation = operation.waitFor();
if (operation.getErrors() == null) {
System.out.println("Disk " + diskId + " was successfully created");
} else {
// inspect operation.getErrors()
throw new RuntimeException("Disk creation failed");
}A Google Compute Engine instance is a virtual machine (VM) hosted on Google's infrastructure. An instance can be created given its identity, a machine type, one boot disk and a network interface. In this code snippet, we will create a virtual machine instance in the default network using as a boot disk the disk we have just created and assigning to it the just created IP address.
Add the following imports at the top of your file:
import com.google.cloud.compute.deprecated.AttachedDisk;
import com.google.cloud.compute.deprecated.AttachedDisk.PersistentDiskConfiguration;
import com.google.cloud.compute.deprecated.InstanceId;
import com.google.cloud.compute.deprecated.InstanceInfo;
import com.google.cloud.compute.deprecated.MachineTypeId;
import com.google.cloud.compute.deprecated.NetworkConfiguration;
import com.google.cloud.compute.deprecated.NetworkConfiguration.AccessConfig;
import com.google.cloud.compute.deprecated.NetworkId;
import com.google.cloud.compute.deprecated.NetworkInterface;Then add the following code to create an instance and wait for instance creation to terminate.
Address externalIp = compute.getAddress(addressId);
InstanceId instanceId = InstanceId.of("us-central1-a", "test-instance");
NetworkId networkId = NetworkId.of("default");
PersistentDiskConfiguration attachConfiguration =
PersistentDiskConfiguration.newBuilder(diskId).setBoot(true).build();
AttachedDisk attachedDisk = AttachedDisk.of("dev0", attachConfiguration);
NetworkInterface networkInterface = NetworkInterface.newBuilder(networkId)
.setAccessConfigurations(AccessConfig.of(externalIp.getAddress()))
.build();
MachineTypeId machineTypeId = MachineTypeId.of("us-central1-a", "n1-standard-1");
InstanceInfo instance =
InstanceInfo.of(instanceId, machineTypeId, attachedDisk, networkInterface);
Operation operation = compute.create(instance);
// Wait for operation to complete
operation = operation.waitFor();
if (operation.getErrors() == null) {
System.out.println("Instance " + instanceId + " was successfully created");
} else {
// inspect operation.getErrors()
throw new RuntimeException("Instance creation failed");
}In CreateAddressDiskAndInstance.java we put together all the code shown above into one program. The program assumes that you are running on Compute Engine or from your own desktop. To run the example on App Engine, simply move the code from the main method to your application's servlet class and change the print statements to display on your webpage.
Other examples are available too:
- CreateSnapshot.java shows how to create a snapshot from an existing disk
- CreateInstance.java shows how to create a virtual machine instance (shorter sample than the one above)
To get help, follow the instructions in the shared Troubleshooting document.
Compute uses HTTP for the transport layer.
Java 7 or above is required for using this client.
This library has tools to help make tests for code using Cloud Compute.
See TESTING to read more about testing.
This library follows Semantic Versioning.
It is currently in major version zero (0.y.z), which means that anything
may change at any time and the public API should not be considered
stable.
Contributions to this library are always welcome and highly encouraged.
See CONTRIBUTING for more information on how to get started.
Apache 2.0 - See LICENSE for more information.