-
Notifications
You must be signed in to change notification settings - Fork 2.9k
feat(modelarmor): Added code samples for delete, get and list model armor templates #10070
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
telpirion
merged 13 commits into
GoogleCloudPlatform:main
from
tirthrajsinh-zala-crest:modelarmor-list-delete-get-template-samples
May 8, 2025
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
d40e2b2
Added code samples for delete, get and list model armor templates
rudrakhsha-crest 4bc2d54
Added create template code snippet
rudrakhsha-crest 22f1b67
feat(modelarmor): refactor code
tirthrajsinh-zala-crest 7dff76b
feat(modelarmor): refactor code
tirthrajsinh-zala-crest d851777
address-review-comments
harshnasitcrest a06a1ce
update-exception
harshnasitcrest 64b62bf
remove-unused-annotation
harshnasitcrest 135fa73
sync-requireenvvar-function-usage
harshnasitcrest c0766f9
remove-require-env-location-condition
harshnasitcrest b6abdad
address-review-comment
harshnasitcrest 82ec0f7
Merge branch 'main' into modelarmor-list-delete-get-template-samples
harshnasitcrest bc405db
resolve-merge-conflicts
harshnasitcrest 47b255b
resolve-merge-conflicts
harshnasitcrest File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package modelarmor; | ||
|
|
||
| // [START modelarmor_get_template] | ||
|
|
||
| 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 java.io.IOException; | ||
|
|
||
| public class GetTemplate { | ||
|
|
||
| public static void main(String[] args) throws IOException { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| String projectId = "your-project-id"; | ||
| String locationId = "your-location-id"; | ||
| String templateId = "your-template-id"; | ||
|
|
||
| getTemplate(projectId, locationId, templateId); | ||
| } | ||
|
|
||
| public static Template getTemplate(String projectId, String locationId, String templateId) | ||
| throws IOException { | ||
| // Construct the API endpoint URL. | ||
| String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId); | ||
|
|
||
| ModelArmorSettings modelArmorSettings = ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint) | ||
| .build(); | ||
|
|
||
| // Initialize the client that will be used to send requests. This client | ||
| // only needs to be created once, and can be reused for multiple requests. | ||
| try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) { | ||
| // Build the template name. | ||
| String name = TemplateName.of(projectId, locationId, templateId).toString(); | ||
|
|
||
| // Get the template. | ||
| Template template = client.getTemplate(name); | ||
|
|
||
| // Find more details about Template object here: | ||
| // https://cloud.google.com/security-command-center/docs/reference/model-armor/rest/v1/projects.locations.templates#Template | ||
| System.out.printf("Retrieved template: %s\n", template.getName()); | ||
|
|
||
| return template; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // [END modelarmor_get_template] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package modelarmor; | ||
|
|
||
| // [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.ModelArmorClient.ListTemplatesPagedResponse; | ||
| import com.google.cloud.modelarmor.v1.ModelArmorSettings; | ||
| import java.io.IOException; | ||
|
|
||
| public class ListTemplates { | ||
|
|
||
| public static void main(String[] args) throws IOException { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| String projectId = "your-project-id"; | ||
| String locationId = "your-location-id"; | ||
|
|
||
| listTemplates(projectId, locationId); | ||
| } | ||
|
|
||
| public static ListTemplatesPagedResponse listTemplates(String projectId, String locationId) | ||
| throws IOException { | ||
| // Construct the API endpoint URL. | ||
| String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId); | ||
|
|
||
| ModelArmorSettings modelArmorSettings = ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint) | ||
| .build(); | ||
|
|
||
| // Initialize the client that will be used to send requests. This client | ||
| // only needs to be created once, and can be reused for multiple requests. | ||
| try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) { | ||
| // Build the parent name. | ||
| String parent = LocationName.of(projectId, locationId).toString(); | ||
|
|
||
| ListTemplatesRequest request = | ||
| ListTemplatesRequest.newBuilder() | ||
| .setParent(parent) | ||
| .build(); | ||
|
|
||
| // List all templates. | ||
| ListTemplatesPagedResponse pagedResponse = client.listTemplates(request); | ||
| pagedResponse.iterateAll().forEach(template -> { | ||
| System.out.printf("Template %s\n", template.getName()); | ||
| }); | ||
|
|
||
| return pagedResponse; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // [END modelarmor_list_templates] | ||
72 changes: 72 additions & 0 deletions
72
modelarmor/src/main/java/modelarmor/ListTemplatesWithFilter.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package modelarmor; | ||
|
|
||
| // [START modelarmor_list_templates_with_filter] | ||
|
|
||
| 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.ModelArmorClient.ListTemplatesPagedResponse; | ||
| import com.google.cloud.modelarmor.v1.ModelArmorSettings; | ||
| import java.io.IOException; | ||
|
|
||
| public class ListTemplatesWithFilter { | ||
|
|
||
| public static void main(String[] args) throws IOException { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
|
|
||
| String projectId = "your-project-id"; | ||
| String locationId = "your-location-id"; | ||
| // Filter to applied. | ||
| // Example: "name=\"projects/your-project-id/locations/us-central1/your-template-id\"" | ||
| String filter = "your-filter-condition"; | ||
|
|
||
| listTemplatesWithFilter(projectId, locationId, filter); | ||
| } | ||
|
|
||
| public static ListTemplatesPagedResponse listTemplatesWithFilter(String projectId, | ||
| String locationId, String filter) throws IOException { | ||
| // Construct the API endpoint URL. | ||
| String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId); | ||
|
|
||
| ModelArmorSettings modelArmorSettings = ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint) | ||
| .build(); | ||
|
|
||
| // Initialize the client that will be used to send requests. This client | ||
| // only needs to be created once, and can be reused for multiple requests. | ||
| try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) { | ||
| // Build the parent name. | ||
| String parent = LocationName.of(projectId, locationId).toString(); | ||
|
|
||
| ListTemplatesRequest request = ListTemplatesRequest.newBuilder() | ||
| .setParent(parent) | ||
| .setFilter(filter) | ||
| .build(); | ||
|
|
||
| // List all templates. | ||
| ListTemplatesPagedResponse pagedResponse = client.listTemplates(request); | ||
| pagedResponse.iterateAll().forEach(template -> { | ||
| System.out.printf("Template %s\n", template.getName()); | ||
| }); | ||
|
|
||
| return pagedResponse; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // [END modelarmor_list_templates_with_filter] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
praise: showing how to page responses from a list operation is a nice-to-have here. Thanks!