Terraform support for Category and Term Resources

mmv1/products/dataplex/Category.yaml

@@ -0,0 +1,99 @@
+# Copyright 2024 Google Inc.
+# 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.
+
+name: 'Category'
+description: |
+  Represents a collection of categories and terms within a Glossary that are related to each other.
+base_url: 'projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/categories/{{category_id}}'
+self_link: 'projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/categories/{{category_id}}'
+create_url: 'projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/categories?category_id={{category_id}}'
+update_verb: 'PATCH'
+update_mask: true
+timeouts:
+  insert_minutes: 5
+  update_minutes: 5
+  delete_minutes: 5
+autogen_async: true
+import_format: ['projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/categories/{{category_id}}']
+examples:
+  - name: 'dataplex_category_basic'
+    primary_resource_id: 'category_test_id'
+    primary_resource_name: 'fmt.Sprintf("tf-test-category-basic%s", context["random_suffix"]), fmt.Sprintf("tf-test-glossary%s", context["random_suffix"])'
+    vars:
+      category_name: 'category-basic'
+  - name: 'dataplex_category_full'
+    primary_resource_id: 'category_test_id_full'
+    primary_resource_name: 'fmt.Sprintf("tf-test-category-full%s", context["random_suffix"]), fmt.Sprintf("tf-test-glossary%s", context["random_suffix"])'
+    vars:
+      category_name: 'category-full'
+parameters:
+  - name: 'location'
+    type: String
+    description: |
+      The location where the glossary category should reside.
+    url_param_only: true
+    required: true
+    immutable: true
+  - name: 'glossaryId'
+    type: String
+    description: |
+      The glossary id for creation.
+    url_param_only: true
+    immutable: true
+  - name: 'categoryId'
+    type: String
+    description: |
+      The category id for creation.
+    url_param_only: true
+    immutable: true
+properties:
+  - name: 'name'
+    type: String
+    description: |
+      The resource name of the GlossaryCategory. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
+    output: true
+  - name: 'displayName'
+    type: String
+    description: |
+      User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the categoryId, if not specified.
+    required: false
+  - name: 'description'
+    type: String
+    description: |
+      The user-mutable description of the GlossaryCategory.
+    required: false
+  - name: 'labels'
+    type: KeyValueLabels
+    description: |
+      User-defined labels for the GlossaryCategory.
+    required: false
+  - name: 'uid'
+    type: String
+    description: |
+      System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+    output: true
+  - name: 'createTime'
+    type: Timestamp
+    description: |
+      The time at which the GlossaryCategory was created.
+    output: true
+  - name: 'updateTime'
+    type: Timestamp
+    description: |
+      The time at which the GlossaryCategory was last updated.
+    output: true
+  - name: 'parent'
+    type: String
+    description: |
+      The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a Category. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId}
+    required: true

mmv1/products/dataplex/Glossary.yaml

@@ -0,0 +1,112 @@
+# Copyright 2025 Google Inc.
+# 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.
+
+name: 'Glossary'
+description: |
+  Represents a collection of categories and terms defined by the user. Glossary is a top level resource and is the GCP parent resource of all the categories and terms within it.
+base_url: 'projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}'
+self_link: 'projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}'
+create_url: 'projects/{{project}}/locations/{{location}}/glossaries?glossary_id={{glossary_id}}'
+update_verb: 'PATCH'
+update_mask: true
+timeouts:
+  insert_minutes: 5
+  update_minutes: 5
+  delete_minutes: 5
+autogen_async: true
+import_format: ['projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}']
+async:
+  actions: ['create', 'delete', 'update']
+  type: 'OpAsync'
+  operation:
+    base_url: '{{op_id}}'
+iam_policy:
+  method_name_separator: ':'
+  parent_resource_attribute: 'glossary_id'
+  import_format:
+    - 'projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}'
+    - '{{glossary_id}}'
+examples:
+  - name: 'dataplex_glossary_basic'
+    primary_resource_id: 'glossary_test_id'
+    primary_resource_name: 'fmt.Sprintf("tf-test-glossary-basic%s", context["random_suffix"])'
+    vars:
+      glossary_name: 'glossary-basic'
+  - name: 'dataplex_glossary_full'
+    primary_resource_id: 'glossary_test_id_full'
+    primary_resource_name: 'fmt.Sprintf("tf-test-glossary-full%s", context["random_suffix"])'
+    vars:
+      glossary_name: 'glossary-full'
+parameters:
+  - name: 'location'
+    type: String
+    description: |
+      The location where the glossary should reside.
+    url_param_only: true
+    required: true
+    immutable: true
+  - name: 'glossaryId'
+    type: String
+    description: |
+      The glossary id for creation.
+    url_param_only: true
+    required: true
+    immutable: true
+properties:
+  - name: 'name'
+    type: String
+    description: |
+      The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
+    output: true
+  - name: 'displayName'
+    type: String
+    description: |
+      User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
+    required: false
+  - name: 'description'
+    type: String
+    description: |
+      The user-mutable description of the glossary.
+    required: false
+  - name: 'labels'
+    type: KeyValueLabels
+    description: |
+      User-defined labels for the Glossary.
+    required: false
+  - name: 'uid'
+    type: String
+    description: |
+      System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+    output: true
+  - name: 'createTime'
+    type: Timestamp
+    description: |
+      The time at which the glossary was created.
+    output: true
+  - name: 'updateTime'
+    type: Timestamp
+    description: |
+      The time at which the glossary was last updated.
+    output: true
+  - name: 'termCount'
+    type: Integer
+    description: |
+      The number of terms in the glossary.
+    required: false
+    output: true
+  - name: 'categoryCount'
+    type: Integer
+    description: |
+      The number of categories in the glossary.
+    required: false
+    output: true

mmv1/products/dataplex/Term.yaml

@@ -0,0 +1,99 @@
+# Copyright 2024 Google Inc.
+# 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.
+
+name: 'Term'
+description: |
+  Represents a collection of terms within a Glossary that are related to each other.
+base_url: 'projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/terms/{{term_id}}'
+self_link: 'projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/terms/{{term_id}}'
+create_url: 'projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/terms?term_id={{term_id}}'
+update_verb: 'PATCH'
+update_mask: true
+timeouts:
+  insert_minutes: 5
+  update_minutes: 5
+  delete_minutes: 5
+autogen_async: true
+import_format: ['projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}/terms/{{term_id}}']
+examples:
+  - name: 'dataplex_term_basic'
+    primary_resource_id: 'term_test_id'
+    primary_resource_name: 'fmt.Sprintf("tf-test-term-basic%s", context["random_suffix"]), fmt.Sprintf("tf-test-glossary%s", context["random_suffix"])'
+    vars:
+      term_name: 'term-basic'
+  - name: 'dataplex_term_full'
+    primary_resource_id: 'term_test_id_full'
+    primary_resource_name: 'fmt.Sprintf("tf-test-term-full%s", context["random_suffix"]), fmt.Sprintf("tf-test-glossary%s", context["random_suffix"])'
+    vars:
+      term_name: 'term-full'
+parameters:
+  - name: 'location'
+    type: String
+    description: |
+      The location where the glossary term should reside.
+    url_param_only: true
+    required: true
+    immutable: true
+  - name: 'glossaryId'
+    type: String
+    description: |
+      The glossary id for creation.
+    url_param_only: true
+    immutable: true
+  - name: 'termId'
+    type: String
+    description: |
+      The term id for creation.
+    url_param_only: true
+    immutable: true
+properties:
+  - name: 'name'
+    type: String
+    description: |
+      The resource name of the GlossaryTerm. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/categories/{termId}
+    output: true
+  - name: 'displayName'
+    type: String
+    description: |
+      User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the termId, if not specified.
+    required: false
+  - name: 'description'
+    type: String
+    description: |
+      The user-mutable description of the GlossaryTerm.
+    required: false
+  - name: 'labels'
+    type: KeyValueLabels
+    description: |
+      User-defined labels for the GlossaryTerm.
+    required: false
+  - name: 'uid'
+    type: String
+    description: |
+      System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+    output: true
+  - name: 'createTime'
+    type: Timestamp
+    description: |
+      The time at which the GlossaryTerm was created.
+    output: true
+  - name: 'updateTime'
+    type: Timestamp
+    description: |
+      The time at which the GlossaryTerm was last updated.
+    output: true
+  - name: 'parent'
+    type: String
+    description: |
+      The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a Term. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId} OR projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId}
+    required: true

mmv1/templates/terraform/examples/dataplex_category_basic.tf.tmpl

@@ -0,0 +1,11 @@
+resource "google_dataplex_glossary" "{{$.PrimaryResourceId}}" {
+  glossary_id = "tf-test-glossary%{random_suffix}"
+  location = "us-central1"
+}
+
+resource "google_dataplex_category" "{{$.PrimaryResourceId}}" {
+  parent = "projects/${google_dataplex_glossary.category_test_id.project}/locations/us-central1/glossaries/${google_dataplex_glossary.category_test_id.glossary_id}"
+  glossary_id = google_dataplex_glossary.category_test_id.glossary_id 
+  location = "us-central1"
+  category_id = "tf-test-category-basic%{random_suffix}"
+}

mmv1/templates/terraform/examples/dataplex_category_full.tf.tmpl

@@ -0,0 +1,15 @@
+resource "google_dataplex_glossary" "{{$.PrimaryResourceId}}" {
+  glossary_id = "tf-test-glossary%{random_suffix}"
+  location    = "us-central1"
+}
+
+resource "google_dataplex_category" "{{$.PrimaryResourceId}}" {
+  parent         = "projects/${google_dataplex_glossary.category_test_id_full.project}/locations/us-central1/glossaries/${google_dataplex_glossary.category_test_id_full.glossary_id}"
+  glossary_id = google_dataplex_glossary.category_test_id_full.glossary_id
+  location    = "us-central1"
+  category_id = "tf-test-category-full%{random_suffix}"
+
+  labels = { "tag": "test-tf" }
+  display_name = "terraform category"
+  description = "category created by Terraform"
+}

mmv1/templates/terraform/examples/dataplex_glossary_basic.tf.tmpl

@@ -0,0 +1,4 @@
+resource "google_dataplex_glossary" "{{$.PrimaryResourceId}}" {
+  glossary_id = "{{index $.Vars "glossary_name"}}"
+  location = "us-central1"
+}

mmv1/templates/terraform/examples/dataplex_glossary_full.tf.tmpl

@@ -0,0 +1,8 @@
+resource "google_dataplex_glossary" "{{$.PrimaryResourceId}}" {
+  glossary_id = "{{index $.Vars "glossary_name"}}"
+  location     = "us-central1"
+
+  labels = { "tag": "test-tf" }
+  display_name = "terraform glossary"
+  description = "glossary created by Terraform"
+}

mmv1/templates/terraform/examples/dataplex_term_basic.tf.tmpl

@@ -0,0 +1,11 @@
+resource "google_dataplex_glossary" "{{$.PrimaryResourceId}}" {
+  glossary_id = "tf-test-glossary%{random_suffix}"
+  location = "us-central1"
+}
+
+resource "google_dataplex_term" "{{$.PrimaryResourceId}}" {
+  parent = "projects/${google_dataplex_glossary.term_test_id.project}/locations/us-central1/glossaries/${google_dataplex_glossary.term_test_id.glossary_id}"
+  glossary_id = google_dataplex_glossary.term_test_id.glossary_id 
+  location = "us-central1"
+  term_id = "tf-test-term-basic%{random_suffix}"
+}

mmv1/templates/terraform/examples/dataplex_term_full.tf.tmpl

@@ -0,0 +1,15 @@
+resource "google_dataplex_glossary" "{{$.PrimaryResourceId}}" {
+  glossary_id = "tf-test-glossary%{random_suffix}"
+  location    = "us-central1"
+}
+
+resource "google_dataplex_term" "{{$.PrimaryResourceId}}" {
+  parent = "projects/${google_dataplex_glossary.term_test_id_full.project}/locations/us-central1/glossaries/${google_dataplex_glossary.term_test_id_full.glossary_id}"
+  glossary_id = google_dataplex_glossary.term_test_id_full.glossary_id
+  location = "us-central1"
+  term_id = "tf-test-term-full%{random_suffix}"
+
+  labels = { "tag": "test-tf" }
+  display_name = "terraform term"
+  description = "term created by Terraform"
+}