pulumi-gcp 8.32.0a1747459264__py3-none-any.whl → 8.32.1__py3-none-any.whl

pulumi_gcp/dataplex/glossary.py

@@ -0,0 +1,772 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from .. import _utilities
+
+__all__ = ['GlossaryArgs', 'Glossary']
+
+@pulumi.input_type
+class GlossaryArgs:
+    def __init__(__self__, *,
+                 glossary_id: pulumi.Input[builtins.str],
+                 location: pulumi.Input[builtins.str],
+                 description: Optional[pulumi.Input[builtins.str]] = None,
+                 display_name: Optional[pulumi.Input[builtins.str]] = None,
+                 labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
+                 project: Optional[pulumi.Input[builtins.str]] = None):
+        """
+        The set of arguments for constructing a Glossary resource.
+        :param pulumi.Input[builtins.str] glossary_id: The glossary id for creation.
+               
+               
+               - - -
+        :param pulumi.Input[builtins.str] location: The location where the glossary should reside.
+        :param pulumi.Input[builtins.str] description: The user-mutable description of the glossary.
+        :param pulumi.Input[builtins.str] display_name: User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
+        :param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] labels: User-defined labels for the Glossary.
+               
+               **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
+               Please refer to the field `effective_labels` for all of the labels present on the resource.
+        :param pulumi.Input[builtins.str] project: The ID of the project in which the resource belongs.
+               If it is not provided, the provider project is used.
+        """
+        pulumi.set(__self__, "glossary_id", glossary_id)
+        pulumi.set(__self__, "location", location)
+        if description is not None:
+            pulumi.set(__self__, "description", description)
+        if display_name is not None:
+            pulumi.set(__self__, "display_name", display_name)
+        if labels is not None:
+            pulumi.set(__self__, "labels", labels)
+        if project is not None:
+            pulumi.set(__self__, "project", project)
+
+    @property
+    @pulumi.getter(name="glossaryId")
+    def glossary_id(self) -> pulumi.Input[builtins.str]:
+        """
+        The glossary id for creation.
+
+
+        - - -
+        """
+        return pulumi.get(self, "glossary_id")
+
+    @glossary_id.setter
+    def glossary_id(self, value: pulumi.Input[builtins.str]):
+        pulumi.set(self, "glossary_id", value)
+
+    @property
+    @pulumi.getter
+    def location(self) -> pulumi.Input[builtins.str]:
+        """
+        The location where the glossary should reside.
+        """
+        return pulumi.get(self, "location")
+
+    @location.setter
+    def location(self, value: pulumi.Input[builtins.str]):
+        pulumi.set(self, "location", value)
+
+    @property
+    @pulumi.getter
+    def description(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        The user-mutable description of the glossary.
+        """
+        return pulumi.get(self, "description")
+
+    @description.setter
+    def description(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "description", value)
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
+        """
+        return pulumi.get(self, "display_name")
+
+    @display_name.setter
+    def display_name(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "display_name", value)
+
+    @property
+    @pulumi.getter
+    def labels(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]:
+        """
+        User-defined labels for the Glossary.
+
+        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
+        Please refer to the field `effective_labels` for all of the labels present on the resource.
+        """
+        return pulumi.get(self, "labels")
+
+    @labels.setter
+    def labels(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]):
+        pulumi.set(self, "labels", value)
+
+    @property
+    @pulumi.getter
+    def project(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        The ID of the project in which the resource belongs.
+        If it is not provided, the provider project is used.
+        """
+        return pulumi.get(self, "project")
+
+    @project.setter
+    def project(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "project", value)
+
+
+@pulumi.input_type
+class _GlossaryState:
+    def __init__(__self__, *,
+                 category_count: Optional[pulumi.Input[builtins.int]] = None,
+                 create_time: Optional[pulumi.Input[builtins.str]] = None,
+                 description: Optional[pulumi.Input[builtins.str]] = None,
+                 display_name: Optional[pulumi.Input[builtins.str]] = None,
+                 effective_labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
+                 glossary_id: Optional[pulumi.Input[builtins.str]] = None,
+                 labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
+                 location: Optional[pulumi.Input[builtins.str]] = None,
+                 name: Optional[pulumi.Input[builtins.str]] = None,
+                 project: Optional[pulumi.Input[builtins.str]] = None,
+                 pulumi_labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
+                 term_count: Optional[pulumi.Input[builtins.int]] = None,
+                 uid: Optional[pulumi.Input[builtins.str]] = None,
+                 update_time: Optional[pulumi.Input[builtins.str]] = None):
+        """
+        Input properties used for looking up and filtering Glossary resources.
+        :param pulumi.Input[builtins.int] category_count: The number of categories in the glossary.
+        :param pulumi.Input[builtins.str] create_time: The time at which the glossary was created.
+        :param pulumi.Input[builtins.str] description: The user-mutable description of the glossary.
+        :param pulumi.Input[builtins.str] display_name: User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
+        :param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] effective_labels: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
+        :param pulumi.Input[builtins.str] glossary_id: The glossary id for creation.
+               
+               
+               - - -
+        :param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] labels: User-defined labels for the Glossary.
+               
+               **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
+               Please refer to the field `effective_labels` for all of the labels present on the resource.
+        :param pulumi.Input[builtins.str] location: The location where the glossary should reside.
+        :param pulumi.Input[builtins.str] name: The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
+        :param pulumi.Input[builtins.str] project: The ID of the project in which the resource belongs.
+               If it is not provided, the provider project is used.
+        :param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] pulumi_labels: The combination of labels configured directly on the resource
+               and default labels configured on the provider.
+        :param pulumi.Input[builtins.int] term_count: The number of terms in the glossary.
+        :param pulumi.Input[builtins.str] uid: System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+        :param pulumi.Input[builtins.str] update_time: The time at which the glossary was last updated.
+        """
+        if category_count is not None:
+            pulumi.set(__self__, "category_count", category_count)
+        if create_time is not None:
+            pulumi.set(__self__, "create_time", create_time)
+        if description is not None:
+            pulumi.set(__self__, "description", description)
+        if display_name is not None:
+            pulumi.set(__self__, "display_name", display_name)
+        if effective_labels is not None:
+            pulumi.set(__self__, "effective_labels", effective_labels)
+        if glossary_id is not None:
+            pulumi.set(__self__, "glossary_id", glossary_id)
+        if labels is not None:
+            pulumi.set(__self__, "labels", labels)
+        if location is not None:
+            pulumi.set(__self__, "location", location)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if project is not None:
+            pulumi.set(__self__, "project", project)
+        if pulumi_labels is not None:
+            pulumi.set(__self__, "pulumi_labels", pulumi_labels)
+        if term_count is not None:
+            pulumi.set(__self__, "term_count", term_count)
+        if uid is not None:
+            pulumi.set(__self__, "uid", uid)
+        if update_time is not None:
+            pulumi.set(__self__, "update_time", update_time)
+
+    @property
+    @pulumi.getter(name="categoryCount")
+    def category_count(self) -> Optional[pulumi.Input[builtins.int]]:
+        """
+        The number of categories in the glossary.
+        """
+        return pulumi.get(self, "category_count")
+
+    @category_count.setter
+    def category_count(self, value: Optional[pulumi.Input[builtins.int]]):
+        pulumi.set(self, "category_count", value)
+
+    @property
+    @pulumi.getter(name="createTime")
+    def create_time(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        The time at which the glossary was created.
+        """
+        return pulumi.get(self, "create_time")
+
+    @create_time.setter
+    def create_time(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "create_time", value)
+
+    @property
+    @pulumi.getter
+    def description(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        The user-mutable description of the glossary.
+        """
+        return pulumi.get(self, "description")
+
+    @description.setter
+    def description(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "description", value)
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
+        """
+        return pulumi.get(self, "display_name")
+
+    @display_name.setter
+    def display_name(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "display_name", value)
+
+    @property
+    @pulumi.getter(name="effectiveLabels")
+    def effective_labels(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]:
+        """
+        All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
+        """
+        return pulumi.get(self, "effective_labels")
+
+    @effective_labels.setter
+    def effective_labels(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]):
+        pulumi.set(self, "effective_labels", value)
+
+    @property
+    @pulumi.getter(name="glossaryId")
+    def glossary_id(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        The glossary id for creation.
+
+
+        - - -
+        """
+        return pulumi.get(self, "glossary_id")
+
+    @glossary_id.setter
+    def glossary_id(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "glossary_id", value)
+
+    @property
+    @pulumi.getter
+    def labels(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]:
+        """
+        User-defined labels for the Glossary.
+
+        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
+        Please refer to the field `effective_labels` for all of the labels present on the resource.
+        """
+        return pulumi.get(self, "labels")
+
+    @labels.setter
+    def labels(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]):
+        pulumi.set(self, "labels", value)
+
+    @property
+    @pulumi.getter
+    def location(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        The location where the glossary should reside.
+        """
+        return pulumi.get(self, "location")
+
+    @location.setter
+    def location(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "location", value)
+
+    @property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
+        """
+        return pulumi.get(self, "name")
+
+    @name.setter
+    def name(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "name", value)
+
+    @property
+    @pulumi.getter
+    def project(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        The ID of the project in which the resource belongs.
+        If it is not provided, the provider project is used.
+        """
+        return pulumi.get(self, "project")
+
+    @project.setter
+    def project(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "project", value)
+
+    @property
+    @pulumi.getter(name="pulumiLabels")
+    def pulumi_labels(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]:
+        """
+        The combination of labels configured directly on the resource
+        and default labels configured on the provider.
+        """
+        return pulumi.get(self, "pulumi_labels")
+
+    @pulumi_labels.setter
+    def pulumi_labels(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]]):
+        pulumi.set(self, "pulumi_labels", value)
+
+    @property
+    @pulumi.getter(name="termCount")
+    def term_count(self) -> Optional[pulumi.Input[builtins.int]]:
+        """
+        The number of terms in the glossary.
+        """
+        return pulumi.get(self, "term_count")
+
+    @term_count.setter
+    def term_count(self, value: Optional[pulumi.Input[builtins.int]]):
+        pulumi.set(self, "term_count", value)
+
+    @property
+    @pulumi.getter
+    def uid(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+        """
+        return pulumi.get(self, "uid")
+
+    @uid.setter
+    def uid(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "uid", value)
+
+    @property
+    @pulumi.getter(name="updateTime")
+    def update_time(self) -> Optional[pulumi.Input[builtins.str]]:
+        """
+        The time at which the glossary was last updated.
+        """
+        return pulumi.get(self, "update_time")
+
+    @update_time.setter
+    def update_time(self, value: Optional[pulumi.Input[builtins.str]]):
+        pulumi.set(self, "update_time", value)
+
+
+@pulumi.type_token("gcp:dataplex/glossary:Glossary")
+class Glossary(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 description: Optional[pulumi.Input[builtins.str]] = None,
+                 display_name: Optional[pulumi.Input[builtins.str]] = None,
+                 glossary_id: Optional[pulumi.Input[builtins.str]] = None,
+                 labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
+                 location: Optional[pulumi.Input[builtins.str]] = None,
+                 project: Optional[pulumi.Input[builtins.str]] = None,
+                 __props__=None):
+        """
+        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.
+
+        ## Example Usage
+
+        ### Dataplex Glossary Basic
+
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+
+        glossary_test_id = gcp.dataplex.Glossary("glossary_test_id",
+            glossary_id="glossary-basic",
+            location="us-central1")
+        ```
+        ### Dataplex Glossary Full
+
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+
+        glossary_test_id_full = gcp.dataplex.Glossary("glossary_test_id_full",
+            glossary_id="glossary-full",
+            location="us-central1",
+            labels={
+                "tag": "test-tf",
+            },
+            display_name="terraform glossary",
+            description="glossary created by Terraform")
+        ```
+
+        ## Import
+
+        Glossary can be imported using any of these accepted formats:
+
+        * `projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}`
+
+        * `{{project}}/{{location}}/{{glossary_id}}`
+
+        * `{{location}}/{{glossary_id}}`
+
+        When using the `pulumi import` command, Glossary can be imported using one of the formats above. For example:
+
+        ```sh
+        $ pulumi import gcp:dataplex/glossary:Glossary default projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}
+        ```
+
+        ```sh
+        $ pulumi import gcp:dataplex/glossary:Glossary default {{project}}/{{location}}/{{glossary_id}}
+        ```
+
+        ```sh
+        $ pulumi import gcp:dataplex/glossary:Glossary default {{location}}/{{glossary_id}}
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[builtins.str] description: The user-mutable description of the glossary.
+        :param pulumi.Input[builtins.str] display_name: User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
+        :param pulumi.Input[builtins.str] glossary_id: The glossary id for creation.
+               
+               
+               - - -
+        :param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] labels: User-defined labels for the Glossary.
+               
+               **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
+               Please refer to the field `effective_labels` for all of the labels present on the resource.
+        :param pulumi.Input[builtins.str] location: The location where the glossary should reside.
+        :param pulumi.Input[builtins.str] project: The ID of the project in which the resource belongs.
+               If it is not provided, the provider project is used.
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: GlossaryArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        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.
+
+        ## Example Usage
+
+        ### Dataplex Glossary Basic
+
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+
+        glossary_test_id = gcp.dataplex.Glossary("glossary_test_id",
+            glossary_id="glossary-basic",
+            location="us-central1")
+        ```
+        ### Dataplex Glossary Full
+
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+
+        glossary_test_id_full = gcp.dataplex.Glossary("glossary_test_id_full",
+            glossary_id="glossary-full",
+            location="us-central1",
+            labels={
+                "tag": "test-tf",
+            },
+            display_name="terraform glossary",
+            description="glossary created by Terraform")
+        ```
+
+        ## Import
+
+        Glossary can be imported using any of these accepted formats:
+
+        * `projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}`
+
+        * `{{project}}/{{location}}/{{glossary_id}}`
+
+        * `{{location}}/{{glossary_id}}`
+
+        When using the `pulumi import` command, Glossary can be imported using one of the formats above. For example:
+
+        ```sh
+        $ pulumi import gcp:dataplex/glossary:Glossary default projects/{{project}}/locations/{{location}}/glossaries/{{glossary_id}}
+        ```
+
+        ```sh
+        $ pulumi import gcp:dataplex/glossary:Glossary default {{project}}/{{location}}/{{glossary_id}}
+        ```
+
+        ```sh
+        $ pulumi import gcp:dataplex/glossary:Glossary default {{location}}/{{glossary_id}}
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param GlossaryArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(GlossaryArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 description: Optional[pulumi.Input[builtins.str]] = None,
+                 display_name: Optional[pulumi.Input[builtins.str]] = None,
+                 glossary_id: Optional[pulumi.Input[builtins.str]] = None,
+                 labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
+                 location: Optional[pulumi.Input[builtins.str]] = None,
+                 project: Optional[pulumi.Input[builtins.str]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = GlossaryArgs.__new__(GlossaryArgs)
+
+            __props__.__dict__["description"] = description
+            __props__.__dict__["display_name"] = display_name
+            if glossary_id is None and not opts.urn:
+                raise TypeError("Missing required property 'glossary_id'")
+            __props__.__dict__["glossary_id"] = glossary_id
+            __props__.__dict__["labels"] = labels
+            if location is None and not opts.urn:
+                raise TypeError("Missing required property 'location'")
+            __props__.__dict__["location"] = location
+            __props__.__dict__["project"] = project
+            __props__.__dict__["category_count"] = None
+            __props__.__dict__["create_time"] = None
+            __props__.__dict__["effective_labels"] = None
+            __props__.__dict__["name"] = None
+            __props__.__dict__["pulumi_labels"] = None
+            __props__.__dict__["term_count"] = None
+            __props__.__dict__["uid"] = None
+            __props__.__dict__["update_time"] = None
+        secret_opts = pulumi.ResourceOptions(additional_secret_outputs=["effectiveLabels", "pulumiLabels"])
+        opts = pulumi.ResourceOptions.merge(opts, secret_opts)
+        super(Glossary, __self__).__init__(
+            'gcp:dataplex/glossary:Glossary',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            category_count: Optional[pulumi.Input[builtins.int]] = None,
+            create_time: Optional[pulumi.Input[builtins.str]] = None,
+            description: Optional[pulumi.Input[builtins.str]] = None,
+            display_name: Optional[pulumi.Input[builtins.str]] = None,
+            effective_labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
+            glossary_id: Optional[pulumi.Input[builtins.str]] = None,
+            labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
+            location: Optional[pulumi.Input[builtins.str]] = None,
+            name: Optional[pulumi.Input[builtins.str]] = None,
+            project: Optional[pulumi.Input[builtins.str]] = None,
+            pulumi_labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]]] = None,
+            term_count: Optional[pulumi.Input[builtins.int]] = None,
+            uid: Optional[pulumi.Input[builtins.str]] = None,
+            update_time: Optional[pulumi.Input[builtins.str]] = None) -> 'Glossary':
+        """
+        Get an existing Glossary resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[builtins.int] category_count: The number of categories in the glossary.
+        :param pulumi.Input[builtins.str] create_time: The time at which the glossary was created.
+        :param pulumi.Input[builtins.str] description: The user-mutable description of the glossary.
+        :param pulumi.Input[builtins.str] display_name: User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
+        :param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] effective_labels: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
+        :param pulumi.Input[builtins.str] glossary_id: The glossary id for creation.
+               
+               
+               - - -
+        :param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] labels: User-defined labels for the Glossary.
+               
+               **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
+               Please refer to the field `effective_labels` for all of the labels present on the resource.
+        :param pulumi.Input[builtins.str] location: The location where the glossary should reside.
+        :param pulumi.Input[builtins.str] name: The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
+        :param pulumi.Input[builtins.str] project: The ID of the project in which the resource belongs.
+               If it is not provided, the provider project is used.
+        :param pulumi.Input[Mapping[str, pulumi.Input[builtins.str]]] pulumi_labels: The combination of labels configured directly on the resource
+               and default labels configured on the provider.
+        :param pulumi.Input[builtins.int] term_count: The number of terms in the glossary.
+        :param pulumi.Input[builtins.str] uid: System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+        :param pulumi.Input[builtins.str] update_time: The time at which the glossary was last updated.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _GlossaryState.__new__(_GlossaryState)
+
+        __props__.__dict__["category_count"] = category_count
+        __props__.__dict__["create_time"] = create_time
+        __props__.__dict__["description"] = description
+        __props__.__dict__["display_name"] = display_name
+        __props__.__dict__["effective_labels"] = effective_labels
+        __props__.__dict__["glossary_id"] = glossary_id
+        __props__.__dict__["labels"] = labels
+        __props__.__dict__["location"] = location
+        __props__.__dict__["name"] = name
+        __props__.__dict__["project"] = project
+        __props__.__dict__["pulumi_labels"] = pulumi_labels
+        __props__.__dict__["term_count"] = term_count
+        __props__.__dict__["uid"] = uid
+        __props__.__dict__["update_time"] = update_time
+        return Glossary(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="categoryCount")
+    def category_count(self) -> pulumi.Output[builtins.int]:
+        """
+        The number of categories in the glossary.
+        """
+        return pulumi.get(self, "category_count")
+
+    @property
+    @pulumi.getter(name="createTime")
+    def create_time(self) -> pulumi.Output[builtins.str]:
+        """
+        The time at which the glossary was created.
+        """
+        return pulumi.get(self, "create_time")
+
+    @property
+    @pulumi.getter
+    def description(self) -> pulumi.Output[Optional[builtins.str]]:
+        """
+        The user-mutable description of the glossary.
+        """
+        return pulumi.get(self, "description")
+
+    @property
+    @pulumi.getter(name="displayName")
+    def display_name(self) -> pulumi.Output[Optional[builtins.str]]:
+        """
+        User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
+        """
+        return pulumi.get(self, "display_name")
+
+    @property
+    @pulumi.getter(name="effectiveLabels")
+    def effective_labels(self) -> pulumi.Output[Mapping[str, builtins.str]]:
+        """
+        All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
+        """
+        return pulumi.get(self, "effective_labels")
+
+    @property
+    @pulumi.getter(name="glossaryId")
+    def glossary_id(self) -> pulumi.Output[builtins.str]:
+        """
+        The glossary id for creation.
+
+
+        - - -
+        """
+        return pulumi.get(self, "glossary_id")
+
+    @property
+    @pulumi.getter
+    def labels(self) -> pulumi.Output[Optional[Mapping[str, builtins.str]]]:
+        """
+        User-defined labels for the Glossary.
+
+        **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
+        Please refer to the field `effective_labels` for all of the labels present on the resource.
+        """
+        return pulumi.get(self, "labels")
+
+    @property
+    @pulumi.getter
+    def location(self) -> pulumi.Output[builtins.str]:
+        """
+        The location where the glossary should reside.
+        """
+        return pulumi.get(self, "location")
+
+    @property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[builtins.str]:
+        """
+        The resource name of the Glossary. Format: projects/{projectId}/locations/{locationId}/glossaries/{glossaryId}
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def project(self) -> pulumi.Output[builtins.str]:
+        """
+        The ID of the project in which the resource belongs.
+        If it is not provided, the provider project is used.
+        """
+        return pulumi.get(self, "project")
+
+    @property
+    @pulumi.getter(name="pulumiLabels")
+    def pulumi_labels(self) -> pulumi.Output[Mapping[str, builtins.str]]:
+        """
+        The combination of labels configured directly on the resource
+        and default labels configured on the provider.
+        """
+        return pulumi.get(self, "pulumi_labels")
+
+    @property
+    @pulumi.getter(name="termCount")
+    def term_count(self) -> pulumi.Output[builtins.int]:
+        """
+        The number of terms in the glossary.
+        """
+        return pulumi.get(self, "term_count")
+
+    @property
+    @pulumi.getter
+    def uid(self) -> pulumi.Output[builtins.str]:
+        """
+        System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+        """
+        return pulumi.get(self, "uid")
+
+    @property
+    @pulumi.getter(name="updateTime")
+    def update_time(self) -> pulumi.Output[builtins.str]:
+        """
+        The time at which the glossary was last updated.
+        """
+        return pulumi.get(self, "update_time")
+