Java idiomatic client for Compute Engine.

• Product Documentation
• Client Library Documentation

If you are using Maven, add this to your pom.xml file:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-compute</artifactId>
  <version>1.7.0</version>
</dependency>

If you are using Gradle without BOM, add this to your dependencies

implementation 'com.google.cloud:google-cloud-compute:1.7.1'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-compute" % "1.7.1"

See the Authentication section in the base directory's README.

The client application making API calls must be granted authorization scopes required for the desired Compute Engine APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Compute Engine API calls.

You will need a Google Cloud Platform Console project with the Compute Engine API enabled. You will need to enable billing to use Google Compute Engine. 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.

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

See the Compute Engine client library docs to learn how to use this Compute Engine Client Library.

From version 1.6.0-beta google-cloud-compute will have the following feature changes:

• Everything except polling methods which used to return Operation now returns OperationFuture.
• Library automatically polls Operation status.
• Operation op = client.myMethod(args) should be replaced with OperationFuture<Operation, Operation> opFuture = client.myMethodAsync(args);
• Manual polling now just calls opFuture.get() and wait for it to complete polling.
• To check for intermediate status on the future use either opFuture.peekMetadata() (non-blocking) or opFuture.getMetadata() (blocking)
• If you wish to stop automatic polling call opFuture.cancel() - it will cancel the future on the client side but it will not affect the execution of the operation on the server side in any way (server will keep working on the operation).
• The calls still may be done without relying on automatic polling and/or OperationFuture. To do so, use client.myMethodCallable(MyMethodRequest).call() semantics instead. Note this semantics does not have flattened method declarations and the request message must be instantiated explicitly by the users code.

The following example creates a GCE address, then lists all the available addresses in the region and in the whole project and eventually deletes the newly created address.

import com.google.cloud.compute.v1.Address;
import com.google.cloud.compute.v1.AddressesClient;
import com.google.cloud.compute.v1.AddressesScopedList;
import com.google.cloud.compute.v1.Operation;
import com.google.protobuf.util.JsonFormat;
import java.io.IOException;
import java.util.Map;

public class ComputeExample {

  public static void main(String[] args) throws IOException, InterruptedException {
    final String project = "PROJECT_NAME";
    final String region = "REGION";
    final String address = "test-address-21";

    AddressesClient addressesClient = AddressesClient.create();

    // AddressClient#insert()
    System.out.println("\n===============\nAddressClient#insert()\n===============");
    OperationFuture<Operation,Operation> insertResponse =
        addressesClient.insertAsync(project, region, Address.newBuilder().setName(address).build());
    Operation insertResponseOperation = insertResponse.get();
    System.out.println(JsonFormat.printer().print(insertResponse) + "\n");

    // AddressClient#list()
    System.out.println("\n===============\nAddressClient#list()\n===============");
    for (Address addr : addressesClient.list(project, region).iterateAll()) {
      System.out.println(JsonFormat.printer().print(addr));
    }

    // AddressClient#aggregatedList()
    System.out.println("\n===============\nAddressClient#aggregatedList()\n===============");
    for (Map.Entry<String, AddressesScopedList> addr :
        addressesClient.aggregatedList(project).iterateAll()) {
      System.out.println("KEY: " + addr.getKey());
      System.out.println(JsonFormat.printer().print(addr.getValue()));
    }

    // AddressClient#delete()
    System.out.println("\n===============\nAddressClient#delete()\n===============");
    OperationFuture<Operation,Operation> deleteResponse = addressesClient.deleteAsync(project, region, address);
    Operation deleteResponseOperation = deleteResponse.get();
    System.out.println(JsonFormat.printer().print(deleteResponse) + "\n");
  }
}

To get help, follow the instructions in the shared Troubleshooting document.

Compute Engine uses HTTP/JSON for the transport layer.

Java 8 or above is required for using this client.

Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).

In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.

Java 11 and (in September 2021) Java 17 are the best choices for new development.

Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).

Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.

The latest versions and the supported Java versions are identified on the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME and on google-cloud-java.

This library follows Semantic Versioning.

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

Apache 2.0 - See LICENSE for more information.

Java Version	Status
Java 8
Java 8 OSX
Java 8 Windows
Java 11

Java is a registered trademark of Oracle and/or its affiliates.