feat(compute): add compute regional template create (#9526)

TetyanaYahodska · web-flow · commit c617f2afce89 · 2024-10-02T11:12:28.000+02:00
* Implemented compute_regional_template_create sample, created delete and get classes, fixed test * Added compute_regional_template_get and compute_regional_template_delete tags * Added comments * Fixed naming and methods parameters * Fixed naming * Fixed test * Changed zone * Changed zone * Changed zone * Changed region * Changed to getZone() * Added clean method * Changed zone to us-central1-a * Deleted clean up methods * Created new branch for testing purposes * Fixed comments, deleted assertions * Added cleanUpExistingInstances for RegionalInstance * Added cleanUpExistingInstances in ReservationIT class * Fixed imports order * Changed zone * Changed zone * Changed timeout * Fixed timeout * Added cleanup method for reservation * Fixed zone for tests classes * added timeout to DeleteProtectionIT * fixed test * fixed cleanup method * Increased timeout * Increased timeout, changed zone * Changed timeout * Changed zone * Changed timeout * Added timeout * Increased timeout * changed name * added timeout * deleted test for create Reservtion * Revert "deleted test for create Reservtion" This reverts commit 761df70. * deleted tests for create Reservation * Revert "deleted tests for create Reservation" This reverts commit df076ba. * added cleanup methods * changed zone * changed zone * disabled test * Splitted test * Fixed test * Changed deletion time * Fixed cleanup methods * Fixed cleanup methods * Fixed cleanup methods * Changed default zones * Changed zones * fixed tests * Fixed tests * Fixed tests * Fixed tests * Fixed tests * Fixed tests
diff --git a/compute/cloud-client/src/main/java/compute/CreateRegionalInstanceTemplate.java b/compute/cloud-client/src/main/java/compute/CreateRegionalInstanceTemplate.java
@@ -0,0 +1,115 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package compute;
+
+// [START compute_regional_template_create]
+
+import com.google.cloud.compute.v1.AttachedDisk;
+import com.google.cloud.compute.v1.AttachedDiskInitializeParams;
+import com.google.cloud.compute.v1.InsertRegionInstanceTemplateRequest;
+import com.google.cloud.compute.v1.InstanceProperties;
+import com.google.cloud.compute.v1.InstanceTemplate;
+import com.google.cloud.compute.v1.NetworkInterface;
+import com.google.cloud.compute.v1.Operation;
+import com.google.cloud.compute.v1.RegionInstanceTemplatesClient;
+import java.io.IOException;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+public class CreateRegionalInstanceTemplate {
+
+  public static void main(String[] args)
+      throws IOException, ExecutionException, InterruptedException, TimeoutException {
+    // TODO(developer): Replace these variables before running the sample.
+    // Project ID or project number of the Cloud project you want to use.
+    String projectId = "YOUR_PROJECT_ID";
+    // Name of the instance you want to create.
+    String instanceName = "YOUR_INSTANCE_NAME";
+    // Name of the region.
+    String region = "us-central1";
+
+    createRegionalInstanceTemplate(projectId, region, instanceName);
+  }
+
+  //  Create a new regional instance template with the provided name and a specific
+  //  instance configuration.
+  public static void createRegionalInstanceTemplate(
+      String projectId, String region, String templateName)
+      throws  IOException, InterruptedException, ExecutionException, TimeoutException {
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests.
+    try (RegionInstanceTemplatesClient templatesClientRegion =
+             RegionInstanceTemplatesClient.create()) {
+
+      String machineType = "n1-standard-1"; // Example machine type
+      String sourceImage = "projects/debian-cloud/global/images/family/debian-11"; // Example image
+
+      // Define the boot disk for the instance template
+      AttachedDisk attachedDisk = AttachedDisk.newBuilder()
+          .setInitializeParams(AttachedDiskInitializeParams.newBuilder()
+              .setSourceImage(sourceImage)
+              .setDiskType("pd-balanced") // Example disk type
+              .setDiskSizeGb(100L) // Example disk size
+              .build())
+          .setAutoDelete(true)
+          .setBoot(true)
+          .build();
+
+      // Define the network interface for the instance template
+      // Note: The subnetwork must be in the same region as the instance template.
+      NetworkInterface networkInterface = NetworkInterface.newBuilder()
+          .setName("my-network-test")
+          .setSubnetwork(String.format("projects/%s/regions/%s/subnetworks/default",
+              projectId, region))
+          .build();
+
+      // Define the instance properties for the template
+      InstanceProperties instanceProperties = InstanceProperties.newBuilder()
+          .addDisks(attachedDisk)
+          .setMachineType(machineType)
+          .addNetworkInterfaces(networkInterface)
+          .build();
+
+      // Build the instance template object
+      InstanceTemplate instanceTemplate = InstanceTemplate.newBuilder()
+          .setName(templateName)
+          .setProperties(instanceProperties)
+          .build();
+
+      // Create the request to insert the instance template
+      InsertRegionInstanceTemplateRequest insertInstanceTemplateRequest =
+          InsertRegionInstanceTemplateRequest
+              .newBuilder()
+              .setProject(projectId)
+              .setRegion(region)
+              .setInstanceTemplateResource(instanceTemplate)
+              .build();
+
+      // Send the request and wait for the operation to complete
+      Operation response = templatesClientRegion.insertAsync(insertInstanceTemplateRequest)
+          .get(3, TimeUnit.MINUTES);
+
+      if (response.hasError()) {
+        System.out.println("Instance Template creation failed! " + response);
+        return;
+      }
+      System.out.printf("Instance Template Operation Status: %s%n", response.getStatus());
+    }
+  }
+}
+// [END compute_regional_template_create]
diff --git a/compute/cloud-client/src/main/java/compute/DeleteRegionalInstanceTemplate.java b/compute/cloud-client/src/main/java/compute/DeleteRegionalInstanceTemplate.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package compute;
+
+// [START compute_regional_template_delete]
+
+import com.google.cloud.compute.v1.DeleteRegionInstanceTemplateRequest;
+import com.google.cloud.compute.v1.Operation;
+import com.google.cloud.compute.v1.RegionInstanceTemplatesClient;
+import java.io.IOException;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+public class DeleteRegionalInstanceTemplate {
+  public static void main(String[] args)
+      throws IOException, ExecutionException, InterruptedException, TimeoutException {
+    // TODO(developer): Replace these variables before running the sample.
+    // Project ID or project number of the Cloud project you want to use.
+    String projectId = "YOUR_PROJECT_ID";
+    // Name of the instance you want to delete.
+    String instanceName = "YOUR_INSTANCE_NAME";
+    // Name of the region.
+    String region = "us-central1";
+
+    deleteRegionalInstanceTemplate(projectId, region, instanceName);
+  }
+
+  // Delete a regional instance template.
+  public static void deleteRegionalInstanceTemplate(
+      String projectId, String region, String templateName)
+      throws IOException, ExecutionException, InterruptedException, TimeoutException {
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests.
+    try (RegionInstanceTemplatesClient regionInstanceTemplatesClient =
+             RegionInstanceTemplatesClient.create()) {
+
+      DeleteRegionInstanceTemplateRequest deleteInstanceTemplateRequest =
+          DeleteRegionInstanceTemplateRequest
+              .newBuilder()
+              .setProject(projectId)
+              .setRegion(region)
+              .setInstanceTemplate(templateName)
+              .build();
+
+      Operation response = regionInstanceTemplatesClient.deleteAsync(
+          deleteInstanceTemplateRequest).get(3, TimeUnit.MINUTES);
+
+      if (response.hasError()) {
+        System.out.println("Instance template deletion failed ! ! " + response);
+        return;
+      }
+      System.out.printf("Instance template deletion operation status for %s: %s ", templateName,
+          response.getStatus());
+    }
+  }
+}
+// [END compute_regional_template_delete]
+
diff --git a/compute/cloud-client/src/main/java/compute/GetRegionalInstanceTemplate.java b/compute/cloud-client/src/main/java/compute/GetRegionalInstanceTemplate.java
@@ -0,0 +1,51 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package compute;
+
+// [START compute_regional_template_get]
+
+import com.google.cloud.compute.v1.InstanceTemplate;
+import com.google.cloud.compute.v1.RegionInstanceTemplatesClient;
+import java.io.IOException;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeoutException;
+
+public class GetRegionalInstanceTemplate {
+  public static void main(String[] args)
+      throws IOException, ExecutionException, InterruptedException, TimeoutException {
+    // TODO(developer): Replace these variables before running the sample.
+    // Project ID or project number of the Cloud project you want to use.
+    String projectId = "YOUR_PROJECT_ID";
+    // Name of the instance you want to get.
+    String instanceName = "YOUR_INSTANCE_NAME";
+    // Name of the region.
+    String region = "us-central1";
+
+    getRegionalInstanceTemplate(projectId, region, instanceName);
+  }
+
+  // Get a regional instance template.
+  public static InstanceTemplate getRegionalInstanceTemplate(
+      String project, String region, String instanceName) throws IOException {
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests.
+    try (RegionInstanceTemplatesClient instancesClient = RegionInstanceTemplatesClient.create()) {
+      return instancesClient.get(project, region, instanceName);
+    }
+  }
+}
+// [END compute_regional_template_get]
diff --git a/compute/cloud-client/src/main/java/compute/reservation/CreateReservation.java b/compute/cloud-client/src/main/java/compute/reservation/CreateReservation.java
@@ -39,7 +39,7 @@ public static void main(String[] args)
     // Name of the zone in which you want to create the disk.
     String zone = "us-central1-a";
     // Name of the reservation you want to create.
-    String reservationName = "test-reservation-name";
+    String reservationName = "YOUR_RESERVATION_NAME";
     // Number of instances in the reservation.
     int numberOfVms = 3;
 
diff --git a/compute/cloud-client/src/test/java/compute/InstancesAdvancedIT.java b/compute/cloud-client/src/test/java/compute/InstancesAdvancedIT.java
@@ -17,7 +17,6 @@
 package compute;
 
 import static com.google.common.truth.Truth.assertWithMessage;
-import static compute.Util.getZone;
 
 import com.google.api.gax.longrunning.OperationFuture;
 import com.google.cloud.compute.v1.Disk;
diff --git a/compute/cloud-client/src/test/java/compute/SnippetsIT.java b/compute/cloud-client/src/test/java/compute/SnippetsIT.java
@@ -24,6 +24,7 @@
 import com.google.cloud.compute.v1.AttachedDisk;
 import com.google.cloud.compute.v1.Instance;
 import com.google.cloud.compute.v1.Instance.Status;
+import com.google.cloud.compute.v1.InstanceTemplate;
 import com.google.cloud.compute.v1.InstancesClient;
 import com.google.cloud.compute.v1.Operation;
 import com.google.cloud.compute.v1.UsageExportLocation;
@@ -59,6 +60,7 @@ public class SnippetsIT {
   private static final String PROJECT_ID = System.getenv("GOOGLE_CLOUD_PROJECT");
   private static final String TEST_IMAGE_PROJECT_NAME = "JAVA_DOCS_COMPUTE_TEST_IMAGE_PROJECT";
   private static final String ZONE = "asia-south1-a";
+  private static final String REGION = ZONE.substring(0, ZONE.lastIndexOf('-'));
   private static String MACHINE_NAME;
   private static String MACHINE_NAME_LIST_INSTANCE;
   private static String MACHINE_NAME_WAIT_FOR_OP;
@@ -67,6 +69,7 @@ public class SnippetsIT {
   private static String BUCKET_NAME;
   private static String IMAGE_PROJECT_NAME;
   private static String RAW_KEY;
+  private static String REGIONAL_LOCATION_NAME;
 
   private ByteArrayOutputStream stdOut;
 
@@ -90,21 +93,24 @@ public static void setUp()
     MACHINE_NAME_WAIT_FOR_OP = "my-new-test-instance" + UUID.randomUUID();
     MACHINE_NAME_ENCRYPTED = "encrypted-test-instance" + UUID.randomUUID();
     MACHINE_NAME_WITH_SSD = "test-instance-with-ssd" + UUID.randomUUID();
+    REGIONAL_LOCATION_NAME = "test-inst-temp-regional-" + UUID.randomUUID();
     BUCKET_NAME = "my-new-test-bucket" + UUID.randomUUID();
     IMAGE_PROJECT_NAME = getEnvVar(TEST_IMAGE_PROJECT_NAME, "windows-sql-cloud");
     RAW_KEY = Util.getBase64EncodedKey();
 
     // Cleanup existing stale resources.
     Util.cleanUpExistingInstances("my-new-test-instance", PROJECT_ID, ZONE);
     Util.cleanUpExistingInstances("encrypted-test-instance", PROJECT_ID, ZONE);
-    Util.cleanUpExistingInstances("test-instance-", PROJECT_ID, ZONE);
     Util.cleanUpExistingInstances("test-instance-with-ssd", PROJECT_ID, ZONE);
+    Util.cleanUpExistingInstanceTemplates("test-inst-temp-regional", PROJECT_ID);
 
     compute.CreateInstance.createInstance(PROJECT_ID, ZONE, MACHINE_NAME);
     compute.CreateInstance.createInstance(PROJECT_ID, ZONE, MACHINE_NAME_LIST_INSTANCE);
     compute.CreateInstance.createInstance(PROJECT_ID, ZONE, MACHINE_NAME_WAIT_FOR_OP);
     compute.CreateEncryptedInstance
         .createEncryptedInstance(PROJECT_ID, ZONE, MACHINE_NAME_ENCRYPTED, RAW_KEY);
+    CreateRegionalInstanceTemplate
+        .createRegionalInstanceTemplate(PROJECT_ID, REGION, REGIONAL_LOCATION_NAME);
 
     TimeUnit.SECONDS.sleep(30);
 
@@ -130,6 +136,8 @@ public static void cleanup()
     compute.DeleteInstance.deleteInstance(PROJECT_ID, ZONE, MACHINE_NAME);
     compute.DeleteInstance.deleteInstance(PROJECT_ID, ZONE, MACHINE_NAME_LIST_INSTANCE);
     compute.DeleteInstance.deleteInstance(PROJECT_ID, ZONE, MACHINE_NAME_WITH_SSD);
+    DeleteRegionalInstanceTemplate
+        .deleteRegionalInstanceTemplate(PROJECT_ID, REGION, REGIONAL_LOCATION_NAME);
 
     // Delete the Google Cloud Storage bucket created for usage reports.
     Storage storage = StorageOptions.newBuilder().setProjectId(PROJECT_ID).build().getService();
@@ -254,4 +262,12 @@ public void testListImagesByPage() throws IOException {
     Assert.assertTrue(stdOut.toString().contains("Page Number: 1"));
   }
 
+  @Test
+  public void testGetRegionalInstanceTemplate() throws IOException {
+    // Check if the instance was successfully created during the setup.
+    InstanceTemplate instanceTemplate = GetRegionalInstanceTemplate
+        .getRegionalInstanceTemplate(PROJECT_ID, REGION,
+        REGIONAL_LOCATION_NAME);
+    Assert.assertEquals(REGIONAL_LOCATION_NAME, instanceTemplate.getName());
+  }
 }
diff --git a/compute/cloud-client/src/test/java/compute/Util.java b/compute/cloud-client/src/test/java/compute/Util.java
diff --git a/compute/cloud-client/src/test/java/compute/reservation/CrudOperationResevationIT.java b/compute/cloud-client/src/test/java/compute/reservation/CrudOperationResevationIT.java
diff --git a/compute/cloud-client/src/test/java/compute/reservation/ReservationIT.java b/compute/cloud-client/src/test/java/compute/reservation/ReservationIT.java
