feat(security-command-center): add sample for creating client with regional endpoint (GoogleCloudPlatform#9547)

hegemonic · minherz · web-flow · commit 124386d21bff · 2024-10-24T11:20:19.000-07:00
* feat(security-command-center): add sample for creating client with regional endpoint The sample also shows how to create a client for the default endpoint. That's because SCC's regional endpoints support only a limited subset of SCC resources that are subject to data residency controls: https://cloud.google.com/security-command-center/docs/data-residency-support#scc-regional-urls-rest As a result, it's likely that customers will need to create two clients: one for their regional endpoint, to call the methods it supports, and another for the default endpoint, to call all other methods. * update package name * address comments * Apply suggestions from code review Co-authored-by: LeoY <minherz@users.noreply.github.com> * streamline sample; fix test Now that we're creating a single client, there's no need to put it in a `Map`. * update comment to reflect code changes --------- Co-authored-by: LeoY <minherz@users.noreply.github.com>
diff --git a/security-command-center/snippets/src/main/java/vtwo/client/CreateClientWithEndpoint.java b/security-command-center/snippets/src/main/java/vtwo/client/CreateClientWithEndpoint.java
@@ -0,0 +1,44 @@
+/*
+ * 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 vtwo.client;
+
+// [START securitycenter_set_client_endpoint_v2]
+
+import com.google.cloud.securitycenter.v2.SecurityCenterClient;
+import com.google.cloud.securitycenter.v2.SecurityCenterSettings;
+import java.io.IOException;
+
+public class CreateClientWithEndpoint {
+
+  public static void main(String[] args) throws IOException {
+    // TODO: Replace the value with the endpoint for the region in which your
+    // Security Command Center data resides.
+    String regionalEndpoint = "securitycenter.me-central2.rep.googleapis.com:443";
+    SecurityCenterClient client = createClientWithEndpoint(regionalEndpoint);
+    System.out.println("Client initiated with endpoint: " + client.getSettings().getEndpoint());
+  }
+
+  // Creates Security Command Center client for a regional endpoint.
+  public static SecurityCenterClient createClientWithEndpoint(String regionalEndpoint)
+      throws java.io.IOException {
+    SecurityCenterSettings regionalSettings =
+        SecurityCenterSettings.newBuilder().setEndpoint(regionalEndpoint).build();
+    return SecurityCenterClient.create(regionalSettings);
+  }
+}
+
+// [END securitycenter_set_client_endpoint_v2]
diff --git a/security-command-center/snippets/src/test/java/vtwo/CreateClientIT.java b/security-command-center/snippets/src/test/java/vtwo/CreateClientIT.java
@@ -0,0 +1,40 @@
+/*
+ * 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 vtwo;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import com.google.cloud.securitycenter.v2.SecurityCenterClient;
+import java.io.IOException;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+import vtwo.client.CreateClientWithEndpoint;
+
+// Test v2 Create Client samples.
+@RunWith(JUnit4.class)
+public class CreateClientIT {
+
+  @Test
+  public void testCreateClientWithEndpoint() throws IOException {
+    SecurityCenterClient client =
+        CreateClientWithEndpoint.createClientWithEndpoint(
+            "securitycenter.me-central2.rep.googleapis.com:443");
+    assertThat(client.getSettings().getEndpoint())
+        .isEqualTo("securitycenter.me-central2.rep.googleapis.com:443");
+  }
+}
