Skip to content
Branch: master
Find file Copy path
Find file Copy path
2 contributors

Users who have contributed to this file

@tswast @kurtisvg
126 lines (110 sloc) 6.25 KB

Compute Engine - Getting started with Java

Open in Cloud Shell

This sample command line application demonstrates how to access the Google Compute Engine API using the Google Java API Client Library.

When the sample is setup and run as instructed below, it will list all the VM instances in a Google Cloud Platform project for a specific zone. The sample also checks for the existence of a VM instance named "my-sample-instance". If the VM instance doesn't exist, the sample will create a new VM instance named "my-sample-instance". If the VM instance does exist, running the sample will delete the instance. The instance create and delete actions are implemented as "zone specific operations". The sample demonstrates how to poll the status of these operations to determine when and if they successfully complete.




Setup Instructions

  1. Create or select a project in the Google Cloud Console:

  2. Visit the Cloud Console

  3. If this is your first time then click "Create Project," otherwise you can reuse an existing project by clicking on it. 1. Note: You will need to enable billing for the project to use Compute Engine.

  4. Click "Overview" in the left-side navigation menu and copy your Project ID for use in step 3.3 below.

  5. Authentication instructions to run the sample (on your local machine or on a Compute Engine VM):

  • Running the sample locally on your development machine:
    1. Install Google Cloud SDK
    2. Run the following command to authorize the Cloud SDK and configure your project:
    gcloud init
  • Running the sample on a Google Compute Engine VM using Default Application Credentials:
    1. Create a Compute Engine VM Instance.
    2. In the Cloud Console go to the Compute > Compute Engine section.
    3. Click the "Create instance" button.
    4. For the 'Boot Disk' select a Linux machine image like Debian or Ubuntu.
    5. Click the "Management, disk, networking, access & security options" section to expand it. 1. Select the "Access and Security" subsection and then select the "Compute" drop-down menu to set its scope.
      • Set the "Compute" access scope to be "Read/Write".
    6. Click the "Create" button.
    7. Once the VM is created click the VM instance's "SSH" button to ssh in to the newly created VM instance.
  1. Code checkout instructions:
  2. Prerequisites: install Java 7 or Java 8 JDK, Git, and Maven. You may need to set your JAVA_HOME environment variable as well. * To install these prerequisites on a Linux (Debian or Ubuntu) based Compute Engine VM instance, run these commands:
    sudo apt-get update
    sudo apt-get install git maven openjdk-7-jdk -y
  3. Download the sample code by running the following commands:
mkdir some_directory
  cd some_directory
  git clone
  cd java-docs-samples/compute/cmdline

In a text editor open the file. For example, to edit the file with nano:

nano src/main/java/
  1. In your text editor update the YOUR_PROJECT_ID value in src/main/java/ so that the following line is updated. Not performing this step will result in an error; specifically, "Parameter 'project' must conform to the pattern...". For more information see setting your Project ID.
private static final String projectId = "YOUR_PROJECT_ID"
  1. Specify an 'Application Name' for your app by updating the following line of code:
private static final String APPLICATION_NAME = "";
  1. Save the changes to the file and exit the text editor.

  2. Compile and run the sample:

  3. Compile the sample code using Maven by running the following command:

mvn compile
  1. Execute the sample code using Maven by running the following command:
mvn -q exec:java
  1. Running the sample will list all Google Compute Engine VM instances found in the zone you specified. The sample will also check for the existence of a VM instance named "my-sample-instance". If the "my-sample-instance" VM does not exist, running the sample will create it. If the "my-sample-instance" VM does already exist then running the sample will delete it.

    You can verify the list of VM instances by running the command gcloud compute instances list. VM instances can be deleted with the 'gcloud compute instance delete' command. For example, this command will delete the 'my-sample-instance' VM instance in the zone 'us-central1-f':

    gcloud compute instances delete my-sample-instance --zone us-central1-f

  2. Importing the code into Eclipse and running it from there:

  3. Prerequisites: install Eclipse and the Maven plugin for Eclipse.

  4. Download code as specified above.

  5. File -> Import -> Maven -> Existing Maven Projects -> Next.

  6. Select your project directory as your "Root Directory," and click "Finish."

  7. Right-click on project compute-engine-cmdline-sample.

  8. Run As > Java Application.

  9. If asked, type or select "ComputeEngineSample" and click OK.

  10. Application output will display in the Eclipse Console.

You can’t perform that action at this time.