feat(modelarmor): refactor code

Author: tirthrajsinh-zala-crest

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

@@ -16,6 +16,8 @@
 
 package modelarmor;
 
+// [START modelarmor_create_template]
+
 import com.google.cloud.modelarmor.v1.CreateTemplateRequest;
 import com.google.cloud.modelarmor.v1.DetectionConfidenceLevel;
 import com.google.cloud.modelarmor.v1.FilterConfig;
@@ -29,8 +31,15 @@
 import com.google.protobuf.util.JsonFormat;
 import java.util.List;
 
+/** This class contains a main method that creates a template using the Model Armor API. */
 public class CreateTemplate {
 
+  /**
+   * Main method that calls the createTemplate method to create a template.
+   *
+   * @param args command line arguments (not used)
+   * @throws Exception if an error occurs during template creation
+   */
   public static void main(String[] args) throws Exception {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "your-project-id";
@@ -40,15 +49,29 @@ public static void main(String[] args) throws Exception {
     createTemplate(projectId, locationId, templateId);
   }
 
+  /**
+   * Creates a template using the Model Armor API.
+   *
+   * @param projectId the ID of the project
+   * @param locationId the ID of the location
+   * @param templateId the ID of the template
+   * @return the created template
+   * @throws Exception if an error occurs during template creation
+   */
   public static Template createTemplate(String projectId, String locationId, String templateId)
       throws Exception {
+    // Construct the API endpoint URL
     String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+
+    // Create a Model Armor settings object with the API endpoint
     ModelArmorSettings modelArmorSettings =
         ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint).build();
 
     try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      // Construct the parent resource name
       String parent = LocationName.of(projectId, locationId).toString();
 
+      // Create a template object with a filter config
       Template template =
           Template.newBuilder()
               .setFilterConfig(
@@ -65,16 +88,23 @@ public static Template createTemplate(String projectId, String locationId, Strin
                       .build())
               .build();
 
+      // Create a create template request object
       CreateTemplateRequest request =
           CreateTemplateRequest.newBuilder()
               .setParent(parent)
               .setTemplateId(templateId)
               .setTemplate(template)
               .build();
 
+      // Create the template using the Model Armor client
       Template createdTemplate = client.createTemplate(request);
+
+      // Print the created template
       System.out.println("Created template: " + JsonFormat.printer().print(createdTemplate));
+
       return createdTemplate;
     }
   }
 }
+
+// [END modelarmor_create_template]

modelarmor/src/main/java/modelarmor/DeleteTemplate.java

@@ -16,12 +16,21 @@
 
 package modelarmor;
 
+// [START modelarmor_delete_template]
+
 import com.google.cloud.modelarmor.v1.ModelArmorClient;
 import com.google.cloud.modelarmor.v1.ModelArmorSettings;
 import com.google.cloud.modelarmor.v1.TemplateName;
 
+/** This class contains a main method that deletes a template using the Model Armor API. */
 public class DeleteTemplate {
 
+  /**
+   * Main method that calls the deleteTemplate method to delete a template.
+   *
+   * @param args command line arguments (not used)
+   * @throws Exception if an error occurs during template deletion
+   */
   public static void main(String[] args) throws Exception {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "your-project-id";
@@ -31,15 +40,34 @@ public static void main(String[] args) throws Exception {
     deleteTemplate(projectId, locationId, templateId);
   }
 
+  /**
+   * Deletes a template using the Model Armor API.
+   *
+   * @param projectId the ID of the project
+   * @param locationId the ID of the location
+   * @param templateId the ID of the template
+   * @throws Exception if an error occurs during template deletion
+   */
   public static void deleteTemplate(String projectId, String locationId, String templateId)
       throws Exception {
+    // Construct the API endpoint URL
     String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+
+    // Create a Model Armor settings object with the API endpoint
     ModelArmorSettings modelArmorSettings =
         ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint).build();
+
     try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      // Construct the template name
       String name = TemplateName.of(projectId, locationId, templateId).toString();
+
+      // Delete the template using the Model Armor client
       client.deleteTemplate(name);
+
+      // Print a success message
       System.out.println("Deleted template: " + name);
     }
   }
 }
+
+// [END modelarmor_delete_template]

modelarmor/src/main/java/modelarmor/GetTemplate.java

@@ -16,14 +16,28 @@
 
 package modelarmor;
 
+/**
+ * This class demonstrates how to retrieve a template using the Model Armor API.
+ *
+ * @author [Your Name]
+ */
 import com.google.cloud.modelarmor.v1.ModelArmorClient;
 import com.google.cloud.modelarmor.v1.ModelArmorSettings;
 import com.google.cloud.modelarmor.v1.Template;
 import com.google.cloud.modelarmor.v1.TemplateName;
 import com.google.protobuf.util.JsonFormat;
 
+// [START modelarmor_get_template]
+
+/** This class contains a main method that retrieves a template using the Model Armor API. */
 public class GetTemplate {
 
+  /**
+   * Main method that calls the getTemplate method to retrieve a template.
+   *
+   * @param args command line arguments (not used)
+   * @throws Exception if an error occurs during template retrieval
+   */
   public static void main(String[] args) throws Exception {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "your-project-id";
@@ -33,16 +47,34 @@ public static void main(String[] args) throws Exception {
     getTemplate(projectId, locationId, templateId);
   }
 
+  /**
+   * Retrieves a template using the Model Armor API.
+   *
+   * @param projectId the ID of the project
+   * @param locationId the ID of the location
+   * @param templateId the ID of the template
+   * @throws Exception if an error occurs during template retrieval
+   */
   public static void getTemplate(String projectId, String locationId, String templateId)
       throws Exception {
+    // Construct the API endpoint URL
     String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+
+    // Create a Model Armor settings object with the API endpoint
     ModelArmorSettings modelArmorSettings =
         ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint).build();
 
     try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      // Construct the template name
       String name = TemplateName.of(projectId, locationId, templateId).toString();
+
+      // Retrieve the template using the Model Armor client
       Template template = client.getTemplate(name);
+
+      // Print the retrieved template
       System.out.println("Retrieved template: " + JsonFormat.printer().print(template));
     }
   }
 }
+
+// [END modelarmor_get_template]

modelarmor/src/main/java/modelarmor/ListTemplates.java

@@ -16,15 +16,30 @@
 
 package modelarmor;
 
+/**
+ * This class demonstrates how to list templates using the Model Armor API.
+ *
+ * @author [Your Name]
+ */
+
+// [START modelarmor_list_templates]
+
 import com.google.cloud.modelarmor.v1.ListTemplatesRequest;
 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.Template;
 import com.google.protobuf.util.JsonFormat;
 
+/** This class contains a main method that lists templates using the Model Armor API. */
 public class ListTemplates {
 
+  /**
+   * Main method that calls the listTemplates method to list templates.
+   *
+   * @param args command line arguments (not used)
+   * @throws Exception if an error occurs during template listing
+   */
   public static void main(String[] args) throws Exception {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "your-project-id";
@@ -33,17 +48,35 @@ public static void main(String[] args) throws Exception {
     listTemplates(projectId, locationId);
   }
 
+  /**
+   * Lists templates using the Model Armor API.
+   *
+   * @param projectId the ID of the project
+   * @param locationId the ID of the location
+   * @throws Exception if an error occurs during template listing
+   */
   public static void listTemplates(String projectId, String locationId) throws Exception {
+    // Construct the API endpoint URL
     String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+
+    // Create a Model Armor settings object with the API endpoint
     ModelArmorSettings modelArmorSettings =
         ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint).build();
 
     try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      // Construct the parent resource name
       String parent = LocationName.of(projectId, locationId).toString();
+
+      // Create a list templates request object
       ListTemplatesRequest request = ListTemplatesRequest.newBuilder().setParent(parent).build();
+
+      // List templates using the Model Armor client
       for (Template template : client.listTemplates(request).iterateAll()) {
-        System.out.println("Retrived Templates: " + JsonFormat.printer().print(template));
+        // Print each retrieved template
+        System.out.println("Retrieved Templates: " + JsonFormat.printer().print(template));
       }
     }
   }
 }
+
+// [END modelarmor_list_templates]

modelarmor/src/main/java/modelarmor/ListTemplatesWithFilter.java

@@ -16,15 +16,31 @@
 
 package modelarmor;
 
+/**
+ * This class demonstrates how to list templates with a filter using the Model Armor API.
+ *
+ * @author [Your Name]
+ */
 import com.google.cloud.modelarmor.v1.ListTemplatesRequest;
 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.Template;
 import com.google.protobuf.util.JsonFormat;
 
+// [START modelarmor_list_templates_with_filter]
+
+/**
+ * This class contains a main method that lists templates with a filter using the Model Armor API.
+ */
 public class ListTemplatesWithFilter {
 
+  /**
+   * Main method that calls the listTemplatesWithFilter method to list templates with a filter.
+   *
+   * @param args command line arguments (not used)
+   * @throws Exception if an error occurs during template listing
+   */
   public static void main(String[] args) throws Exception {
     // TODO(developer): Replace these variables before running the sample.
     String projectId = "your-project-id";
@@ -34,18 +50,37 @@ public static void main(String[] args) throws Exception {
     listTemplatesWithFilter(projectId, locationId, templateId);
   }
 
+  /**
+   * Lists templates with a filter using the Model Armor API.
+   *
+   * @param projectId the ID of the project
+   * @param locationId the ID of the location
+   * @param templateId the ID of the template
+   * @throws Exception if an error occurs during template listing
+   */
   public static void listTemplatesWithFilter(String projectId, String locationId, String templateId)
       throws Exception {
+    // Construct the API endpoint URL
     String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+
+    // Create a Model Armor settings object with the API endpoint
     ModelArmorSettings modelArmorSettings =
         ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint).build();
 
     try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      // Construct the parent resource name
       String parent = LocationName.of(projectId, locationId).toString();
+
+      // Construct the filter string
       String filter = String.format("name=\"%s/templates/%s\"", parent, templateId);
+
+      // Create a list templates request object with the filter
       ListTemplatesRequest request =
           ListTemplatesRequest.newBuilder().setParent(parent).setFilter(filter).build();
+
+      // List templates using the Model Armor client
       for (Template template : client.listTemplates(request).iterateAll()) {
+        // Print each retrieved template
         System.out.println("Template with filter: " + JsonFormat.printer().print(template));
       }
     }

modelarmor/src/test/java/modelarmor/SnippetsIT.java

@@ -97,7 +97,7 @@ public void testGetModelArmorTemplate() throws Exception {
   public void testListModelArmorTemplates() throws Exception {
     CreateTemplate.createTemplate(PROJECT_ID, LOCATION, TEMPLATE_ID);
     ListTemplates.listTemplates(PROJECT_ID, LOCATION);
-    assertThat(stdOut.toString()).contains("Retrived Templates");
+    assertThat(stdOut.toString()).contains("Retrieved Templates");
     DeleteTemplate.deleteTemplate(PROJECT_ID, LOCATION, TEMPLATE_ID);
   }