closed as deprecated: feat(modelarmor): Added create, update, delete, list modelarmor code snippets

modelarmor/README.md

@@ -0,0 +1,29 @@
+# Google Model Armor
+
+<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=modelarmor/README.md">
+<img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a>
+
+Google Model Armor is a fully managed Google Cloud service that enhances the security and safety of AI applications by screening LLM prompts and responses for various security and safety risks. [More Details](https://cloud.google.com/security-command-center/docs/model-armor-overview)
+
+These sample Java code snippets demonstrate how to access the Model Armor API using the Google Java API Client Libraries.
+
+## Prerequisites
+
+### Enable the API
+
+The following page details the permissions required for Model Armor and provides instructions for enabling and disabling Model Armor:
+[Enable Model Armor API](https://cloud.google.com/security-command-center/docs/get-started-model-armor#enable-model-armor)
+
+### Grant Permissions
+You must ensure that the [user account or service account](https://cloud.google.com/iam/docs/service-accounts#differences_between_a_service_account_and_a_user_account) you used to authorize your gcloud session has the proper permissions to edit Secret Manager resources for your project. In the Cloud Console under IAM, add the following roles to the project whose service account you're using to test:
+* Model Armor Admin (roles/modelarmor.admin)
+* Floor Settings Admin (modelarmor.floorSettingsAdmin)
+
+More information can be found in the [Model Armor Docs](https://cloud.google.com/security-command-center/docs/get-started-model-armor#required_permissions)
+
+### Set Environment Variables
+
+You must set your project ID to run the tests:
+```shell
+export GOOGLE_CLOUD_PROJECT=<your-project-id-here>
+```

modelarmor/pom.xml

@@ -0,0 +1,112 @@
+<!--
+ Copyright 2025 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.
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.example.modelarmor</groupId>
+  <artifactId>modelarmor-samples</artifactId>
+  <packaging>jar</packaging>
+
+  <!--
+    The parent pom defines common style checks and testing strategies for our samples.
+    Removing or replacing it should not affect the execution of the samples in anyway.
+  -->
+  <parent>
+    <groupId>com.google.cloud.samples</groupId>
+    <artifactId>shared-configuration</artifactId>
+    <version>1.2.0</version>
+  </parent>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <maven.compiler.target>11</maven.compiler.target>
+    <maven.compiler.source>11</maven.compiler.source>
+  </properties>
+
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>com.google.cloud</groupId>
+        <artifactId>libraries-bom</artifactId>
+        <version>26.59.0</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+
+  <dependencies>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-modelarmor</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-dlp</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>com.google.protobuf</groupId>
+      <artifactId>protobuf-java-util</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.projectlombok</groupId>
+      <artifactId>lombok</artifactId>
+      <version>1.18.30</version>
+      <scope>provided</scope>
+    </dependency>
+
+    <!-- test dependencies -->
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.13.2</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.truth</groupId>
+      <artifactId>truth</artifactId>
+      <version>1.4.0</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <version>3.12.1</version>
+        <configuration>
+          <source>11</source> <!-- depending on your project -->
+          <target>11</target> <!-- depending on your project -->
+          <annotationProcessorPaths>
+            <path>
+              <groupId>org.projectlombok</groupId>
+              <artifactId>lombok</artifactId>
+              <version>1.18.30</version>
+            </path>
+          </annotationProcessorPaths>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>

modelarmor/src/main/java/modelarmor/CreateTemplate.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2020 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 modelarmor;
+
+//  TODO(nasit): Add region tags in all snippets.
+import com.google.cloud.modelarmor.v1.CreateTemplateRequest;
+import com.google.cloud.modelarmor.v1.DetectionConfidenceLevel;
+import com.google.cloud.modelarmor.v1.FilterConfig;
+import com.google.cloud.modelarmor.v1.LocationName;
+import com.google.cloud.modelarmor.v1.ModelArmorClient;
+import com.google.cloud.modelarmor.v1.ModelArmorSettings;
+import com.google.cloud.modelarmor.v1.RaiFilterSettings;
+import com.google.cloud.modelarmor.v1.RaiFilterSettings.RaiFilter;
+import com.google.cloud.modelarmor.v1.RaiFilterType;
+import com.google.cloud.modelarmor.v1.Template;
+import com.google.protobuf.util.JsonFormat;
+import java.util.Arrays;
+import java.util.List;
+
+public class CreateTemplate {
+
+  public static void main(String[] args) throws Exception {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "your-project-id";
+    String locationId = "your-location-id";
+    String templateId = "your-template-id";
+
+    createTemplate(projectId, locationId, templateId);
+  }
+
+  public static Template createTemplate(String projectId, String locationId, String templateId)
+      throws Exception {
+    String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+    ModelArmorSettings modelArmorSettings =
+        ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint).build();
+
+    try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      String parent = LocationName.of(projectId, locationId).toString();
+
+      Template template =
+          Template.newBuilder()
+              .setFilterConfig(
+                  FilterConfig.newBuilder()
+                      .setRaiSettings(
+                          RaiFilterSettings.newBuilder()
+                              .addAllRaiFilters(
+                                  List.of(
+                                      RaiFilter.newBuilder()
+                                          .setFilterType(RaiFilterType.DANGEROUS)
+                                          .setConfidenceLevel(DetectionConfidenceLevel.HIGH)
+                                          .build()))
+                              .build())
+                      .build())
+              .build();
+
+      CreateTemplateRequest request =
+          CreateTemplateRequest.newBuilder()
+              .setParent(parent)
+              .setTemplateId(templateId)
+              .setTemplate(template)
+              .build();
+
+      Template createdTemplate = client.createTemplate(request);
+      System.out.println("Created template: " + JsonFormat.printer().print(createdTemplate));
+      return createdTemplate;
+    }
+  }
+}

modelarmor/src/main/java/modelarmor/CreateTemplateWithBasicSdp.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright 2020 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 modelarmor;
+
+import com.google.cloud.modelarmor.v1.CreateTemplateRequest;
+import com.google.cloud.modelarmor.v1.DetectionConfidenceLevel;
+import com.google.cloud.modelarmor.v1.FilterConfig;
+import com.google.cloud.modelarmor.v1.LocationName;
+import com.google.cloud.modelarmor.v1.ModelArmorClient;
+import com.google.cloud.modelarmor.v1.ModelArmorSettings;
+import com.google.cloud.modelarmor.v1.RaiFilterSettings;
+import com.google.cloud.modelarmor.v1.RaiFilterSettings.RaiFilter;
+import com.google.cloud.modelarmor.v1.RaiFilterType;
+import com.google.cloud.modelarmor.v1.Template;
+import com.google.protobuf.util.JsonFormat;
+import java.util.Arrays;
+import java.util.List;
+
+public class CreateTemplateWithBasicSdp {
+
+  public static void main(String[] args) throws Exception {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "your-project-id";
+    String locationId = "your-location-id";
+    String templateId = "your-template-id";
+
+    createTemplateWithBasicSdp(projectId, locationId, templateId);
+  }
+
+  public static void createTemplateWithBasicSdp(
+      String projectId, String locationId, String templateId) throws Exception {
+    String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+    ModelArmorSettings modelArmorSettings =
+        ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint).build();
+
+    try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      String parent = LocationName.of(projectId, locationId).toString();
+
+      Template template =
+          Template.newBuilder()
+              .setFilterConfig(
+                  FilterConfig.newBuilder()
+                      .setRaiSettings(
+                          RaiFilterSettings.newBuilder()
+                              .addAllRaiFilters(
+                                  List.of(
+                                      RaiFilter.newBuilder()
+                                          .setFilterType(RaiFilterType.DANGEROUS)
+                                          .setConfidenceLevel(DetectionConfidenceLevel.HIGH)
+                                          .build()))
+                              .build())
+                      .build())
+              .build();
+
+      CreateTemplateRequest request =
+          CreateTemplateRequest.newBuilder()
+              .setParent(parent)
+              .setTemplateId(templateId)
+              .setTemplate(template)
+              .build();
+
+      Template createdTemplate = client.createTemplate(request);
+      System.out.println(
+          "Created template with basic sdp: " + JsonFormat.printer().print(createdTemplate));
+    }
+  }
+}

modelarmor/src/main/java/modelarmor/CreateTemplateWithLabels.java

@@ -0,0 +1,87 @@
+/*
+ * Copyright 2020 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 modelarmor;
+
+import com.google.cloud.modelarmor.v1.CreateTemplateRequest;
+import com.google.cloud.modelarmor.v1.DetectionConfidenceLevel;
+import com.google.cloud.modelarmor.v1.FilterConfig;
+import com.google.cloud.modelarmor.v1.LocationName;
+import com.google.cloud.modelarmor.v1.ModelArmorClient;
+import com.google.cloud.modelarmor.v1.ModelArmorSettings;
+import com.google.cloud.modelarmor.v1.RaiFilterSettings;
+import com.google.cloud.modelarmor.v1.RaiFilterSettings.RaiFilter;
+import com.google.cloud.modelarmor.v1.RaiFilterType;
+import com.google.cloud.modelarmor.v1.Template;
+import com.google.protobuf.util.JsonFormat;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class CreateTemplateWithLabels {
+
+  public static void main(String[] args) throws Exception {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "your-project-id";
+    String locationId = "your-location-id";
+    String templateId = "your-template-id";
+
+    createTemplateWithLabels(projectId, locationId, templateId);
+  }
+
+  public static void createTemplateWithLabels(
+      String projectId, String locationId, String templateId) throws Exception {
+    String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+    ModelArmorSettings modelArmorSettings =
+        ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint).build();
+
+    try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      String parent = LocationName.of(projectId, locationId).toString();
+
+      Map<String, String> labels = new HashMap<>();
+      labels.put("key1", "value1");
+      labels.put("key2", "value2");
+
+      Template template =
+          Template.newBuilder()
+              .putAllLabels(labels)
+              .setFilterConfig(
+                  FilterConfig.newBuilder()
+                      .setRaiSettings(
+                          RaiFilterSettings.newBuilder()
+                              .addAllRaiFilters(
+                                  List.of(
+                                      RaiFilter.newBuilder()
+                                          .setFilterType(RaiFilterType.DANGEROUS)
+                                          .setConfidenceLevel(DetectionConfidenceLevel.HIGH)
+                                          .build()))
+                              .build())
+                      .build())
+              .build();
+
+      CreateTemplateRequest request =
+          CreateTemplateRequest.newBuilder()
+              .setParent(parent)
+              .setTemplateId(templateId)
+              .setTemplate(template)
+              .build();
+
+      Template createdTemplate = client.createTemplate(request);
+      System.out.println(
+          "Created template with labels: " + JsonFormat.printer().print(createdTemplate));
+    }
+  }
+}