samples: add support for CMMR Phase 2

samples/snippets/src/main/java/com/example/spanner/CreateInstanceConfigSample.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2022 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 com.example.spanner;
+
+// [START spanner_create_instance_config]
+import com.google.api.gax.longrunning.OperationFuture;
+import com.google.cloud.spanner.InstanceAdminClient;
+import com.google.cloud.spanner.InstanceConfig;
+import com.google.cloud.spanner.InstanceConfigId;
+import com.google.cloud.spanner.InstanceConfigInfo;
+import com.google.cloud.spanner.ReplicaInfo;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.common.collect.ImmutableList;
+import com.google.spanner.admin.instance.v1.CreateInstanceConfigMetadata;
+import java.util.List;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+class CreateInstanceConfigSample {
+  static void createInstanceConfig() {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "my-project";
+    String baseInstanceConfig = "my-base-instance-config";
+    String instanceConfigId = "custom-instance-config4";
+    createInstanceConfig(projectId, baseInstanceConfig, instanceConfigId);
+  }
+
+  static void createInstanceConfig(
+      String projectId, String baseInstanceConfig, String instanceConfigId) {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
+      final InstanceAdminClient instanceAdminClient = spanner.getInstanceAdminClient();
+      final InstanceConfig baseConfig = instanceAdminClient.getInstanceConfig(baseInstanceConfig);
+      List<ReplicaInfo> readOnlyReplicas =
+          ImmutableList.of(baseConfig.getOptionalReplicas().get(0));
+      InstanceConfigInfo instanceConfigInfo =
+          InstanceConfig.newBuilder(InstanceConfigId.of(projectId, instanceConfigId), baseConfig)
+              .setDisplayName(instanceConfigId)
+              .addReadOnlyReplicas(readOnlyReplicas)
+              .build();
+      final OperationFuture<InstanceConfig, CreateInstanceConfigMetadata> operation =
+          instanceAdminClient.createInstanceConfig(instanceConfigInfo);
+      try {
+        System.out.printf("Waiting for create operation on %s to complete...\n", instanceConfigId);
+        InstanceConfig instanceConfig = operation.get(5, TimeUnit.MINUTES);
+        System.out.printf("Created instance configuration %s\n", instanceConfig.getId());
+      } catch (ExecutionException | TimeoutException e) {
+        System.out.printf(
+            "Error: Creating instance configuration %s failed with error message %s\n",
+            instanceConfigInfo.getId(), e.getMessage());
+      } catch (InterruptedException e) {
+        System.out.println(
+            "Error: Waiting for createInstanceConfig operation to finish was interrupted");
+      }
+    }
+  }
+}
+// [END spanner_create_instance_config]

samples/snippets/src/main/java/com/example/spanner/DeleteInstanceConfigSample.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2022 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 com.example.spanner;
+
+// [START spanner_delete_instance_config]
+import com.google.cloud.spanner.InstanceAdminClient;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerException;
+import com.google.cloud.spanner.SpannerOptions;
+
+class DeleteInstanceConfigSample {
+  static void deleteInstanceConfig() {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "my-project";
+    String instanceConfigId = "custom-user-config";
+    deleteInstanceConfig(projectId, instanceConfigId);
+  }
+
+  static void deleteInstanceConfig(String projectId, String instanceConfigId) {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
+      final InstanceAdminClient instanceAdminClient = spanner.getInstanceAdminClient();
+      try {
+        System.out.printf("Waiting for delete operation on %s to complete...\n", instanceConfigId);
+        instanceAdminClient.deleteInstanceConfig(instanceConfigId);
+        System.out.printf("Deleted instance configuration %s\n", instanceConfigId);
+      } catch (SpannerException e) {
+        System.out.printf(
+            "Error: Deleting instance configuration %s failed with error message: %s\n",
+            instanceConfigId, e.getMessage());
+      }
+    }
+  }
+}
+// [END spanner_delete_instance_config]

samples/snippets/src/main/java/com/example/spanner/ListInstanceConfigOperationsSample.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2022 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 com.example.spanner;
+
+// [START spanner_list_instance_config_operations]
+import com.google.cloud.spanner.InstanceAdminClient;
+import com.google.cloud.spanner.Options;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.longrunning.Operation;
+import com.google.protobuf.InvalidProtocolBufferException;
+import com.google.spanner.admin.instance.v1.CreateInstanceConfigMetadata;
+
+public class ListInstanceConfigOperationsSample {
+  static void listInstanceConfigOperations() {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "my-project";
+    listInstanceConfigOperations(projectId);
+  }
+
+  static void listInstanceConfigOperations(String projectId) {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
+      final InstanceAdminClient instanceAdminClient = spanner.getInstanceAdminClient();
+
+      try {
+        System.out.printf(
+            "Waiting for listing instance config operations on project %s to complete...\n",
+            projectId);
+        final Iterable<Operation> instanceConfigOperations =
+            instanceAdminClient
+                .listInstanceConfigOperations(
+                    Options.filter(
+                        "(metadata.@type=type.googleapis.com/"
+                        + "google.spanner.admin.instance.v1.CreateInstanceConfigMetadata)"))
+                .iterateAll();
+        for (Operation operation : instanceConfigOperations) {
+          CreateInstanceConfigMetadata metadata =
+              operation.getMetadata().unpack(CreateInstanceConfigMetadata.class);
+          System.out.printf(
+              "List instance config operation on %s is %d%% completed.\n",
+              metadata.getInstanceConfig().getName(), metadata.getProgress().getProgressPercent());
+        }
+      } catch (InvalidProtocolBufferException e) {
+        System.out.printf(
+            "Error: Listing instance config operations failed with error message %s\n",
+            e.getMessage());
+        e.printStackTrace();
+      }
+    }
+  }
+}
+// [END spanner_list_instance_config_operations]

samples/snippets/src/main/java/com/example/spanner/UpdateInstanceConfigSample.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2022 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 com.example.spanner;
+
+// [START spanner_update_instance_config]
+import com.google.api.gax.longrunning.OperationFuture;
+import com.google.cloud.spanner.InstanceAdminClient;
+import com.google.cloud.spanner.InstanceConfig;
+import com.google.cloud.spanner.InstanceConfigId;
+import com.google.cloud.spanner.InstanceConfigInfo;
+import com.google.cloud.spanner.InstanceConfigInfo.InstanceConfigField;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.common.collect.ImmutableList;
+import com.google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+class UpdateInstanceConfigSample {
+  static void updateInstanceConfig() {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "my-project";
+    String instanceConfigId = "custom-instance-config";
+    updateInstanceConfig(projectId, instanceConfigId);
+  }
+
+  static void updateInstanceConfig(String projectId, String instanceConfigId) {
+    try (Spanner spanner =
+        SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
+      final InstanceAdminClient instanceAdminClient = spanner.getInstanceAdminClient();
+      InstanceConfigInfo instanceConfigInfo =
+          InstanceConfig.newBuilder(InstanceConfigId.of(projectId, instanceConfigId))
+              .setDisplayName("updated custom instance config")
+              .addLabel("updated", "true")
+              .build();
+      final OperationFuture<InstanceConfig, UpdateInstanceConfigMetadata> operation =
+          instanceAdminClient.updateInstanceConfig(
+              instanceConfigInfo,
+              ImmutableList.of(InstanceConfigField.DISPLAY_NAME, InstanceConfigField.LABELS));
+      try {
+        System.out.printf("Waiting for update operation on %s to complete...\n", instanceConfigId);
+        InstanceConfig instanceConfig = operation.get(5, TimeUnit.MINUTES);
+        System.out.printf(
+            "Updated instance configuration %s with new display name %s\n",
+            instanceConfig.getId(), instanceConfig.getDisplayName());
+      } catch (ExecutionException | TimeoutException e) {
+        System.out.printf(
+            "Error: Updating instance config %s failed with error message %s\n",
+            instanceConfigInfo.getId(), e.getMessage());
+        e.printStackTrace();
+      } catch (InterruptedException e) {
+        System.out.println(
+            "Error: Waiting for updateInstanceConfig operation to finish was interrupted");
+      }
+    }
+  }
+}
+// [END spanner_update_instance_config]

samples/snippets/src/test/java/com/example/spanner/CustomInstanceConfigSampleIT.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2022 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 com.example.spanner;
+
+import static org.junit.Assert.assertTrue;
+
+import org.junit.Test;
+
+public class CustomInstanceConfigSampleIT extends SampleTestBase {
+
+  @Test
+  public void testCustomInstanceConfigOperations() throws Exception {
+    String customInstanceConfigId = idGenerator.generateInstanceConfigId();
+
+    // Create a random instance config. Display name is set to the instance config id in sample.
+    final String out1 =
+        SampleRunner.runSample(
+            () ->
+                CreateInstanceConfigSample.createInstanceConfig(
+                    projectId, instanceConfigName, customInstanceConfigId));
+    assertTrue(out1.contains("Created instance configuration"));
+
+    // List the instance config operations.
+    final String out2 =
+        SampleRunner.runSample(
+            () ->
+                ListInstanceConfigOperationsSample.listInstanceConfigOperations(projectId));
+    assertTrue(out2.contains("List instance config operation"));
+
+    // Update display name to a randomly generated instance config id.
+    final String out3 =
+        SampleRunner.runSample(
+            () ->
+                UpdateInstanceConfigSample.updateInstanceConfig(
+                    projectId, customInstanceConfigId));
+    assertTrue(out3.contains("Updated instance configuration"));
+
+    // Delete the created instance config.
+    final String out4 =
+        SampleRunner.runSample(
+            () ->
+                DeleteInstanceConfigSample.deleteInstanceConfig(projectId, customInstanceConfigId));
+    assertTrue(out4.contains("Deleted instance configuration"));
+  }
+}

samples/snippets/src/test/java/com/example/spanner/SampleIdGenerator.java

@@ -28,45 +28,60 @@ public class SampleIdGenerator {
 
   private static final int DATABASE_NAME_MAX_LENGTH = 30;
   private static final int BACKUP_NAME_MAX_LENGTH = 30;
+  private static final int INSTANCE_CONFIG_ID_MAX_LENGTH = 30;
   private final List<String> databaseIds;
   private final List<String> backupIds;
+  private final List<String> instanceConfigIds;
   private final String baseDatabaseId;
   private final String baseBackupId;
+  private final String baseInstanceConfigId;
 
-  public SampleIdGenerator(String baseDatabaseId, String baseBackupId) {
+  public SampleIdGenerator(
+      String baseDatabaseId, String baseBackupId, String baseInstanceConfigId) {
     this.baseDatabaseId = baseDatabaseId;
     this.baseBackupId = baseBackupId;
+    this.baseInstanceConfigId = baseInstanceConfigId;
     this.databaseIds = new ArrayList<>();
     this.backupIds = new ArrayList<>();
+    this.instanceConfigIds = new ArrayList<>();
   }
 
   public String generateDatabaseId() {
-    final String databaseId = (
-        baseDatabaseId
-            + "-"
-            + UUID.randomUUID().toString().replaceAll("-", "")
-    ).substring(0, DATABASE_NAME_MAX_LENGTH);
+    final String databaseId =
+        (baseDatabaseId + "-" + UUID.randomUUID().toString().replaceAll("-", ""))
+            .substring(0, DATABASE_NAME_MAX_LENGTH);
 
     databaseIds.add(databaseId);
     return databaseId;
   }
 
   public String generateBackupId() {
-    final String databaseId = (
-        baseBackupId
-            + "-"
-            + UUID.randomUUID().toString().replaceAll("-", "")
-    ).substring(0, BACKUP_NAME_MAX_LENGTH);
+    final String databaseId =
+        (baseBackupId + "-" + UUID.randomUUID().toString().replaceAll("-", ""))
+            .substring(0, BACKUP_NAME_MAX_LENGTH);
 
     backupIds.add(databaseId);
     return databaseId;
   }
 
+  public String generateInstanceConfigId() {
+    final String instanceConfigId =
+        ("custom-" + baseInstanceConfigId + "-" + UUID.randomUUID().toString().replaceAll("-", ""))
+            .substring(0, INSTANCE_CONFIG_ID_MAX_LENGTH);
+
+    instanceConfigIds.add(instanceConfigId);
+    return instanceConfigId;
+  }
+
   public List<String> getDatabaseIds() {
     return databaseIds;
   }
 
   public List<String> getBackupIds() {
     return backupIds;
   }
+
+  public List<String> getInstanceConfigIds() {
+    return instanceConfigIds;
+  }
 }