pulumi-gcp 8.37.0a1751903932__py3-none-any.whl → 8.39.0__py3-none-any.whl

pulumi_gcp/firestore/get_document.py

@@ -0,0 +1,234 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** 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__ = [
+    'GetDocumentResult',
+    'AwaitableGetDocumentResult',
+    'get_document',
+    'get_document_output',
+]
+
+@pulumi.output_type
+class GetDocumentResult:
+    """
+    A collection of values returned by getDocument.
+    """
+    def __init__(__self__, collection=None, create_time=None, database=None, document_id=None, fields=None, id=None, name=None, path=None, project=None, update_time=None):
+        if collection and not isinstance(collection, str):
+            raise TypeError("Expected argument 'collection' to be a str")
+        pulumi.set(__self__, "collection", collection)
+        if create_time and not isinstance(create_time, str):
+            raise TypeError("Expected argument 'create_time' to be a str")
+        pulumi.set(__self__, "create_time", create_time)
+        if database and not isinstance(database, str):
+            raise TypeError("Expected argument 'database' to be a str")
+        pulumi.set(__self__, "database", database)
+        if document_id and not isinstance(document_id, str):
+            raise TypeError("Expected argument 'document_id' to be a str")
+        pulumi.set(__self__, "document_id", document_id)
+        if fields and not isinstance(fields, str):
+            raise TypeError("Expected argument 'fields' to be a str")
+        pulumi.set(__self__, "fields", fields)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if path and not isinstance(path, str):
+            raise TypeError("Expected argument 'path' to be a str")
+        pulumi.set(__self__, "path", path)
+        if project and not isinstance(project, str):
+            raise TypeError("Expected argument 'project' to be a str")
+        pulumi.set(__self__, "project", project)
+        if update_time and not isinstance(update_time, str):
+            raise TypeError("Expected argument 'update_time' to be a str")
+        pulumi.set(__self__, "update_time", update_time)
+
+    @property
+    @pulumi.getter
+    def collection(self) -> builtins.str:
+        return pulumi.get(self, "collection")
+
+    @property
+    @pulumi.getter(name="createTime")
+    def create_time(self) -> builtins.str:
+        return pulumi.get(self, "create_time")
+
+    @property
+    @pulumi.getter
+    def database(self) -> builtins.str:
+        return pulumi.get(self, "database")
+
+    @property
+    @pulumi.getter(name="documentId")
+    def document_id(self) -> builtins.str:
+        return pulumi.get(self, "document_id")
+
+    @property
+    @pulumi.getter
+    def fields(self) -> builtins.str:
+        return pulumi.get(self, "fields")
+
+    @property
+    @pulumi.getter
+    def id(self) -> builtins.str:
+        """
+        The provider-assigned unique ID for this managed resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> builtins.str:
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def path(self) -> builtins.str:
+        return pulumi.get(self, "path")
+
+    @property
+    @pulumi.getter
+    def project(self) -> Optional[builtins.str]:
+        return pulumi.get(self, "project")
+
+    @property
+    @pulumi.getter(name="updateTime")
+    def update_time(self) -> builtins.str:
+        return pulumi.get(self, "update_time")
+
+
+class AwaitableGetDocumentResult(GetDocumentResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetDocumentResult(
+            collection=self.collection,
+            create_time=self.create_time,
+            database=self.database,
+            document_id=self.document_id,
+            fields=self.fields,
+            id=self.id,
+            name=self.name,
+            path=self.path,
+            project=self.project,
+            update_time=self.update_time)
+
+
+def get_document(collection: Optional[builtins.str] = None,
+                 database: Optional[builtins.str] = None,
+                 document_id: Optional[builtins.str] = None,
+                 project: Optional[builtins.str] = None,
+                 opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetDocumentResult:
+    """
+    Reads a document from a Firestore database.
+    See [the official documentation](https://cloud.google.com/firestore/native/docs/)
+    and
+    [API](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents/get/).
+
+    ## Example Usage
+
+    Retrieve a document from the Firestore database.
+
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    mydoc = gcp.firestore.Document("mydoc",
+        project=database["project"],
+        database=database["name"],
+        collection="somenewcollection",
+        document_id="my-doc-id")
+    ```
+
+
+    :param builtins.str collection: The name of the collection of documents.
+    :param builtins.str database: The name of the Firestore database.
+    :param builtins.str document_id: The id of the document to get.
+    :param builtins.str project: The project in which the database resides.
+    """
+    __args__ = dict()
+    __args__['collection'] = collection
+    __args__['database'] = database
+    __args__['documentId'] = document_id
+    __args__['project'] = project
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('gcp:firestore/getDocument:getDocument', __args__, opts=opts, typ=GetDocumentResult).value
+
+    return AwaitableGetDocumentResult(
+        collection=pulumi.get(__ret__, 'collection'),
+        create_time=pulumi.get(__ret__, 'create_time'),
+        database=pulumi.get(__ret__, 'database'),
+        document_id=pulumi.get(__ret__, 'document_id'),
+        fields=pulumi.get(__ret__, 'fields'),
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        path=pulumi.get(__ret__, 'path'),
+        project=pulumi.get(__ret__, 'project'),
+        update_time=pulumi.get(__ret__, 'update_time'))
+def get_document_output(collection: Optional[pulumi.Input[builtins.str]] = None,
+                        database: Optional[pulumi.Input[builtins.str]] = None,
+                        document_id: Optional[pulumi.Input[builtins.str]] = None,
+                        project: Optional[pulumi.Input[Optional[builtins.str]]] = None,
+                        opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetDocumentResult]:
+    """
+    Reads a document from a Firestore database.
+    See [the official documentation](https://cloud.google.com/firestore/native/docs/)
+    and
+    [API](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents/get/).
+
+    ## Example Usage
+
+    Retrieve a document from the Firestore database.
+
+    ```python
+    import pulumi
+    import pulumi_gcp as gcp
+
+    mydoc = gcp.firestore.Document("mydoc",
+        project=database["project"],
+        database=database["name"],
+        collection="somenewcollection",
+        document_id="my-doc-id")
+    ```
+
+
+    :param builtins.str collection: The name of the collection of documents.
+    :param builtins.str database: The name of the Firestore database.
+    :param builtins.str document_id: The id of the document to get.
+    :param builtins.str project: The project in which the database resides.
+    """
+    __args__ = dict()
+    __args__['collection'] = collection
+    __args__['database'] = database
+    __args__['documentId'] = document_id
+    __args__['project'] = project
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('gcp:firestore/getDocument:getDocument', __args__, opts=opts, typ=GetDocumentResult)
+    return __ret__.apply(lambda __response__: GetDocumentResult(
+        collection=pulumi.get(__response__, 'collection'),
+        create_time=pulumi.get(__response__, 'create_time'),
+        database=pulumi.get(__response__, 'database'),
+        document_id=pulumi.get(__response__, 'document_id'),
+        fields=pulumi.get(__response__, 'fields'),
+        id=pulumi.get(__response__, 'id'),
+        name=pulumi.get(__response__, 'name'),
+        path=pulumi.get(__response__, 'path'),
+        project=pulumi.get(__response__, 'project'),
+        update_time=pulumi.get(__response__, 'update_time')))

pulumi_gcp/firestore/index.py

@@ -40,16 +40,18 @@ class IndexArgs:
                composite index is not directional, the `__name__` will be ordered
                `"ASCENDING"` (unless explicitly specified otherwise).
                Structure is documented below.
-        :param pulumi.Input[builtins.str] api_scope: The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API",
-               "MONGODB_COMPATIBLE_API"]
-        :param pulumi.Input[builtins.str] database: The Firestore database id. Defaults to '"(default)"'.
-        :param pulumi.Input[builtins.str] density: The density configuration for this index. Possible values: ["SPARSE_ALL", "SPARSE_ANY", "DENSE"]
-        :param pulumi.Input[builtins.bool] multikey: Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the
-               paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at
-               most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations
-               will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
-        :param pulumi.Input[builtins.str] query_scope: The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP",
-               "COLLECTION_RECURSIVE"]
+        :param pulumi.Input[builtins.str] api_scope: The API scope at which a query is run.
+               Default value is `ANY_API`.
+               Possible values are: `ANY_API`, `DATASTORE_MODE_API`, `MONGODB_COMPATIBLE_API`.
+        :param pulumi.Input[builtins.str] database: The Firestore database id. Defaults to `"(default)"`.
+        :param pulumi.Input[builtins.str] density: The density configuration for this index.
+               Possible values are: `SPARSE_ALL`, `SPARSE_ANY`, `DENSE`.
+        :param pulumi.Input[builtins.bool] multikey: Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
+        :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[builtins.str] query_scope: The scope at which a query is run.
+               Default value is `COLLECTION`.
+               Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
         """
         pulumi.set(__self__, "collection", collection)
         pulumi.set(__self__, "fields", fields)
@@ -100,8 +102,9 @@ class IndexArgs:
     @pulumi.getter(name="apiScope")
     def api_scope(self) -> Optional[pulumi.Input[builtins.str]]:
         """
-        The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API",
-        "MONGODB_COMPATIBLE_API"]
+        The API scope at which a query is run.
+        Default value is `ANY_API`.
+        Possible values are: `ANY_API`, `DATASTORE_MODE_API`, `MONGODB_COMPATIBLE_API`.
         """
         return pulumi.get(self, "api_scope")
 
@@ -113,7 +116,7 @@ class IndexArgs:
     @pulumi.getter
     def database(self) -> Optional[pulumi.Input[builtins.str]]:
         """
-        The Firestore database id. Defaults to '"(default)"'.
+        The Firestore database id. Defaults to `"(default)"`.
         """
         return pulumi.get(self, "database")
 
@@ -125,7 +128,8 @@ class IndexArgs:
     @pulumi.getter
     def density(self) -> Optional[pulumi.Input[builtins.str]]:
         """
-        The density configuration for this index. Possible values: ["SPARSE_ALL", "SPARSE_ANY", "DENSE"]
+        The density configuration for this index.
+        Possible values are: `SPARSE_ALL`, `SPARSE_ANY`, `DENSE`.
         """
         return pulumi.get(self, "density")
 
@@ -137,10 +141,7 @@ class IndexArgs:
     @pulumi.getter
     def multikey(self) -> Optional[pulumi.Input[builtins.bool]]:
         """
-        Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the
-        paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at
-        most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations
-        will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
+        Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
         """
         return pulumi.get(self, "multikey")
 
@@ -151,6 +152,10 @@ class IndexArgs:
     @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
@@ -161,8 +166,9 @@ class IndexArgs:
     @pulumi.getter(name="queryScope")
     def query_scope(self) -> Optional[pulumi.Input[builtins.str]]:
         """
-        The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP",
-        "COLLECTION_RECURSIVE"]
+        The scope at which a query is run.
+        Default value is `COLLECTION`.
+        Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
         """
         return pulumi.get(self, "query_scope")
 
@@ -185,11 +191,13 @@ class _IndexState:
                  query_scope: Optional[pulumi.Input[builtins.str]] = None):
         """
         Input properties used for looking up and filtering Index resources.
-        :param pulumi.Input[builtins.str] api_scope: The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API",
-               "MONGODB_COMPATIBLE_API"]
+        :param pulumi.Input[builtins.str] api_scope: The API scope at which a query is run.
+               Default value is `ANY_API`.
+               Possible values are: `ANY_API`, `DATASTORE_MODE_API`, `MONGODB_COMPATIBLE_API`.
         :param pulumi.Input[builtins.str] collection: The collection being indexed.
-        :param pulumi.Input[builtins.str] database: The Firestore database id. Defaults to '"(default)"'.
-        :param pulumi.Input[builtins.str] density: The density configuration for this index. Possible values: ["SPARSE_ALL", "SPARSE_ANY", "DENSE"]
+        :param pulumi.Input[builtins.str] database: The Firestore database id. Defaults to `"(default)"`.
+        :param pulumi.Input[builtins.str] density: The density configuration for this index.
+               Possible values are: `SPARSE_ALL`, `SPARSE_ANY`, `DENSE`.
         :param pulumi.Input[Sequence[pulumi.Input['IndexFieldArgs']]] fields: The fields supported by this index. The last non-stored field entry is
                always for the field path `__name__`. If, on creation, `__name__` was not
                specified as the last field, it will be added automatically with the same
@@ -197,14 +205,14 @@ class _IndexState:
                composite index is not directional, the `__name__` will be ordered
                `"ASCENDING"` (unless explicitly specified otherwise).
                Structure is documented below.
-        :param pulumi.Input[builtins.bool] multikey: Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the
-               paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at
-               most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations
-               will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
+        :param pulumi.Input[builtins.bool] multikey: Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
         :param pulumi.Input[builtins.str] name: A server defined name for this index. Format:
                `projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/indexes/{{server_generated_id}}`
-        :param pulumi.Input[builtins.str] query_scope: The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP",
-               "COLLECTION_RECURSIVE"]
+        :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[builtins.str] query_scope: The scope at which a query is run.
+               Default value is `COLLECTION`.
+               Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
         """
         if api_scope is not None:
             pulumi.set(__self__, "api_scope", api_scope)
@@ -229,8 +237,9 @@ class _IndexState:
     @pulumi.getter(name="apiScope")
     def api_scope(self) -> Optional[pulumi.Input[builtins.str]]:
         """
-        The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API",
-        "MONGODB_COMPATIBLE_API"]
+        The API scope at which a query is run.
+        Default value is `ANY_API`.
+        Possible values are: `ANY_API`, `DATASTORE_MODE_API`, `MONGODB_COMPATIBLE_API`.
         """
         return pulumi.get(self, "api_scope")
 
@@ -254,7 +263,7 @@ class _IndexState:
     @pulumi.getter
     def database(self) -> Optional[pulumi.Input[builtins.str]]:
         """
-        The Firestore database id. Defaults to '"(default)"'.
+        The Firestore database id. Defaults to `"(default)"`.
         """
         return pulumi.get(self, "database")
 
@@ -266,7 +275,8 @@ class _IndexState:
     @pulumi.getter
     def density(self) -> Optional[pulumi.Input[builtins.str]]:
         """
-        The density configuration for this index. Possible values: ["SPARSE_ALL", "SPARSE_ANY", "DENSE"]
+        The density configuration for this index.
+        Possible values are: `SPARSE_ALL`, `SPARSE_ANY`, `DENSE`.
         """
         return pulumi.get(self, "density")
 
@@ -296,10 +306,7 @@ class _IndexState:
     @pulumi.getter
     def multikey(self) -> Optional[pulumi.Input[builtins.bool]]:
         """
-        Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the
-        paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at
-        most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations
-        will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
+        Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
         """
         return pulumi.get(self, "multikey")
 
@@ -323,6 +330,10 @@ class _IndexState:
     @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
@@ -333,8 +344,9 @@ class _IndexState:
     @pulumi.getter(name="queryScope")
     def query_scope(self) -> Optional[pulumi.Input[builtins.str]]:
         """
-        The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP",
-        "COLLECTION_RECURSIVE"]
+        The scope at which a query is run.
+        Default value is `COLLECTION`.
+        Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
         """
         return pulumi.get(self, "query_scope")
 
@@ -576,11 +588,13 @@ class Index(pulumi.CustomResource):
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[builtins.str] api_scope: The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API",
-               "MONGODB_COMPATIBLE_API"]
+        :param pulumi.Input[builtins.str] api_scope: The API scope at which a query is run.
+               Default value is `ANY_API`.
+               Possible values are: `ANY_API`, `DATASTORE_MODE_API`, `MONGODB_COMPATIBLE_API`.
         :param pulumi.Input[builtins.str] collection: The collection being indexed.
-        :param pulumi.Input[builtins.str] database: The Firestore database id. Defaults to '"(default)"'.
-        :param pulumi.Input[builtins.str] density: The density configuration for this index. Possible values: ["SPARSE_ALL", "SPARSE_ANY", "DENSE"]
+        :param pulumi.Input[builtins.str] database: The Firestore database id. Defaults to `"(default)"`.
+        :param pulumi.Input[builtins.str] density: The density configuration for this index.
+               Possible values are: `SPARSE_ALL`, `SPARSE_ANY`, `DENSE`.
         :param pulumi.Input[Sequence[pulumi.Input[Union['IndexFieldArgs', 'IndexFieldArgsDict']]]] fields: The fields supported by this index. The last non-stored field entry is
                always for the field path `__name__`. If, on creation, `__name__` was not
                specified as the last field, it will be added automatically with the same
@@ -588,12 +602,12 @@ class Index(pulumi.CustomResource):
                composite index is not directional, the `__name__` will be ordered
                `"ASCENDING"` (unless explicitly specified otherwise).
                Structure is documented below.
-        :param pulumi.Input[builtins.bool] multikey: Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the
-               paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at
-               most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations
-               will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
-        :param pulumi.Input[builtins.str] query_scope: The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP",
-               "COLLECTION_RECURSIVE"]
+        :param pulumi.Input[builtins.bool] multikey: Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
+        :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[builtins.str] query_scope: The scope at which a query is run.
+               Default value is `COLLECTION`.
+               Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
         """
         ...
     @overload
@@ -888,11 +902,13 @@ class Index(pulumi.CustomResource):
         :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.str] api_scope: The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API",
-               "MONGODB_COMPATIBLE_API"]
+        :param pulumi.Input[builtins.str] api_scope: The API scope at which a query is run.
+               Default value is `ANY_API`.
+               Possible values are: `ANY_API`, `DATASTORE_MODE_API`, `MONGODB_COMPATIBLE_API`.
         :param pulumi.Input[builtins.str] collection: The collection being indexed.
-        :param pulumi.Input[builtins.str] database: The Firestore database id. Defaults to '"(default)"'.
-        :param pulumi.Input[builtins.str] density: The density configuration for this index. Possible values: ["SPARSE_ALL", "SPARSE_ANY", "DENSE"]
+        :param pulumi.Input[builtins.str] database: The Firestore database id. Defaults to `"(default)"`.
+        :param pulumi.Input[builtins.str] density: The density configuration for this index.
+               Possible values are: `SPARSE_ALL`, `SPARSE_ANY`, `DENSE`.
         :param pulumi.Input[Sequence[pulumi.Input[Union['IndexFieldArgs', 'IndexFieldArgsDict']]]] fields: The fields supported by this index. The last non-stored field entry is
                always for the field path `__name__`. If, on creation, `__name__` was not
                specified as the last field, it will be added automatically with the same
@@ -900,14 +916,14 @@ class Index(pulumi.CustomResource):
                composite index is not directional, the `__name__` will be ordered
                `"ASCENDING"` (unless explicitly specified otherwise).
                Structure is documented below.
-        :param pulumi.Input[builtins.bool] multikey: Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the
-               paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at
-               most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations
-               will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
+        :param pulumi.Input[builtins.bool] multikey: Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
         :param pulumi.Input[builtins.str] name: A server defined name for this index. Format:
                `projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/indexes/{{server_generated_id}}`
-        :param pulumi.Input[builtins.str] query_scope: The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP",
-               "COLLECTION_RECURSIVE"]
+        :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[builtins.str] query_scope: The scope at which a query is run.
+               Default value is `COLLECTION`.
+               Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -928,8 +944,9 @@ class Index(pulumi.CustomResource):
     @pulumi.getter(name="apiScope")
     def api_scope(self) -> pulumi.Output[Optional[builtins.str]]:
         """
-        The API scope at which a query is run. Default value: "ANY_API" Possible values: ["ANY_API", "DATASTORE_MODE_API",
-        "MONGODB_COMPATIBLE_API"]
+        The API scope at which a query is run.
+        Default value is `ANY_API`.
+        Possible values are: `ANY_API`, `DATASTORE_MODE_API`, `MONGODB_COMPATIBLE_API`.
         """
         return pulumi.get(self, "api_scope")
 
@@ -945,7 +962,7 @@ class Index(pulumi.CustomResource):
     @pulumi.getter
     def database(self) -> pulumi.Output[Optional[builtins.str]]:
         """
-        The Firestore database id. Defaults to '"(default)"'.
+        The Firestore database id. Defaults to `"(default)"`.
         """
         return pulumi.get(self, "database")
 
@@ -953,7 +970,8 @@ class Index(pulumi.CustomResource):
     @pulumi.getter
     def density(self) -> pulumi.Output[builtins.str]:
         """
-        The density configuration for this index. Possible values: ["SPARSE_ALL", "SPARSE_ANY", "DENSE"]
+        The density configuration for this index.
+        Possible values are: `SPARSE_ALL`, `SPARSE_ANY`, `DENSE`.
         """
         return pulumi.get(self, "density")
 
@@ -975,10 +993,7 @@ class Index(pulumi.CustomResource):
     @pulumi.getter
     def multikey(self) -> pulumi.Output[Optional[builtins.bool]]:
         """
-        Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the
-        paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at
-        most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations
-        will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
+        Optional. Whether the index is multikey. By default, the index is not multikey. For non-multikey indexes, none of the paths in the index definition reach or traverse an array, except via an explicit array index. For multikey indexes, at most one of the paths in the index definition reach or traverse an array, except via an explicit array index. Violations will result in errors. Note this field only applies to indexes with MONGODB_COMPATIBLE_API ApiScope.
         """
         return pulumi.get(self, "multikey")
 
@@ -994,14 +1009,19 @@ class Index(pulumi.CustomResource):
     @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="queryScope")
     def query_scope(self) -> pulumi.Output[Optional[builtins.str]]:
         """
-        The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP",
-        "COLLECTION_RECURSIVE"]
+        The scope at which a query is run.
+        Default value is `COLLECTION`.
+        Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
         """
         return pulumi.get(self, "query_scope")
 

pulumi_gcp/firestore/outputs.py

@@ -351,8 +351,6 @@ class IndexFieldVectorConfig(dict):
         :param builtins.int dimension: The resulting index will only include vectors of this dimension, and can be used for vector search
                with the same dimension.
         :param 'IndexFieldVectorConfigFlatArgs' flat: Indicates the vector index is a flat index.
-               
-               - - -
         """
         if dimension is not None:
             pulumi.set(__self__, "dimension", dimension)
@@ -373,8 +371,6 @@ class IndexFieldVectorConfig(dict):
     def flat(self) -> Optional['outputs.IndexFieldVectorConfigFlat']:
         """
         Indicates the vector index is a flat index.
-
-        - - -
         """
         return pulumi.get(self, "flat")
 

pulumi_gcp/folder/_inputs.py

@@ -71,8 +71,6 @@ if not MYPY:
         The enrollment level of the service.
         Default value is `BLOCK_ALL`.
         Possible values are: `BLOCK_ALL`.
-
-        - - -
         """
 elif False:
     AccessApprovalSettingsEnrolledServiceArgsDict: TypeAlias = Mapping[str, Any]
@@ -109,8 +107,6 @@ class AccessApprovalSettingsEnrolledServiceArgs:
         :param pulumi.Input[builtins.str] enrollment_level: The enrollment level of the service.
                Default value is `BLOCK_ALL`.
                Possible values are: `BLOCK_ALL`.
-               
-               - - -
         """
         pulumi.set(__self__, "cloud_product", cloud_product)
         if enrollment_level is not None:
@@ -157,8 +153,6 @@ class AccessApprovalSettingsEnrolledServiceArgs:
         The enrollment level of the service.
         Default value is `BLOCK_ALL`.
         Possible values are: `BLOCK_ALL`.
-
-        - - -
         """
         return pulumi.get(self, "enrollment_level")