pulumi-gcp 7.19.0a1713292926__py3-none-any.whl → 7.19.0a1713444144__py3-none-any.whl

pulumi_gcp/firestore/_inputs.py

@@ -17,6 +17,8 @@ __all__ = [
     'FieldIndexConfigIndexArgs',
     'FieldTtlConfigArgs',
     'IndexFieldArgs',
+    'IndexFieldVectorConfigArgs',
+    'IndexFieldVectorConfigFlatArgs',
 ]
 
 @pulumi.input_type
@@ -244,17 +246,19 @@ class IndexFieldArgs:
     def __init__(__self__, *,
                  array_config: Optional[pulumi.Input[str]] = None,
                  field_path: Optional[pulumi.Input[str]] = None,
-                 order: Optional[pulumi.Input[str]] = None):
+                 order: Optional[pulumi.Input[str]] = None,
+                 vector_config: Optional[pulumi.Input['IndexFieldVectorConfigArgs']] = None):
         """
-        :param pulumi.Input[str] array_config: Indicates that this field supports operations on arrayValues. Only one of `order` and `arrayConfig` can
-               be specified.
+        :param pulumi.Input[str] array_config: Indicates that this field supports operations on arrayValues. Only one of `order`, `arrayConfig`, and
+               `vectorConfig` can be specified.
                Possible values are: `CONTAINS`.
-               
-               - - -
         :param pulumi.Input[str] field_path: Name of the field.
         :param pulumi.Input[str] order: Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
-               Only one of `order` and `arrayConfig` can be specified.
+               Only one of `order`, `arrayConfig`, and `vectorConfig` can be specified.
                Possible values are: `ASCENDING`, `DESCENDING`.
+        :param pulumi.Input['IndexFieldVectorConfigArgs'] vector_config: Indicates that this field supports vector search operations. Only one of `order`, `arrayConfig`, and
+               `vectorConfig` can be specified. Vector Fields should come after the field path `__name__`.
+               Structure is documented below.
         """
         if array_config is not None:
             pulumi.set(__self__, "array_config", array_config)
@@ -262,16 +266,16 @@ class IndexFieldArgs:
             pulumi.set(__self__, "field_path", field_path)
         if order is not None:
             pulumi.set(__self__, "order", order)
+        if vector_config is not None:
+            pulumi.set(__self__, "vector_config", vector_config)
 
     @property
     @pulumi.getter(name="arrayConfig")
     def array_config(self) -> Optional[pulumi.Input[str]]:
         """
-        Indicates that this field supports operations on arrayValues. Only one of `order` and `arrayConfig` can
-        be specified.
+        Indicates that this field supports operations on arrayValues. Only one of `order`, `arrayConfig`, and
+        `vectorConfig` can be specified.
         Possible values are: `CONTAINS`.
-
-        - - -
         """
         return pulumi.get(self, "array_config")
 
@@ -296,7 +300,7 @@ class IndexFieldArgs:
     def order(self) -> Optional[pulumi.Input[str]]:
         """
         Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
-        Only one of `order` and `arrayConfig` can be specified.
+        Only one of `order`, `arrayConfig`, and `vectorConfig` can be specified.
         Possible values are: `ASCENDING`, `DESCENDING`.
         """
         return pulumi.get(self, "order")
@@ -305,4 +309,69 @@ class IndexFieldArgs:
     def order(self, value: Optional[pulumi.Input[str]]):
         pulumi.set(self, "order", value)
 
+    @property
+    @pulumi.getter(name="vectorConfig")
+    def vector_config(self) -> Optional[pulumi.Input['IndexFieldVectorConfigArgs']]:
+        """
+        Indicates that this field supports vector search operations. Only one of `order`, `arrayConfig`, and
+        `vectorConfig` can be specified. Vector Fields should come after the field path `__name__`.
+        Structure is documented below.
+        """
+        return pulumi.get(self, "vector_config")
+
+    @vector_config.setter
+    def vector_config(self, value: Optional[pulumi.Input['IndexFieldVectorConfigArgs']]):
+        pulumi.set(self, "vector_config", value)
+
+
+@pulumi.input_type
+class IndexFieldVectorConfigArgs:
+    def __init__(__self__, *,
+                 dimension: Optional[pulumi.Input[int]] = None,
+                 flat: Optional[pulumi.Input['IndexFieldVectorConfigFlatArgs']] = None):
+        """
+        :param pulumi.Input[int] dimension: The resulting index will only include vectors of this dimension, and can be used for vector search
+               with the same dimension.
+        :param pulumi.Input['IndexFieldVectorConfigFlatArgs'] flat: Indicates the vector index is a flat index.
+               
+               - - -
+        """
+        if dimension is not None:
+            pulumi.set(__self__, "dimension", dimension)
+        if flat is not None:
+            pulumi.set(__self__, "flat", flat)
+
+    @property
+    @pulumi.getter
+    def dimension(self) -> Optional[pulumi.Input[int]]:
+        """
+        The resulting index will only include vectors of this dimension, and can be used for vector search
+        with the same dimension.
+        """
+        return pulumi.get(self, "dimension")
+
+    @dimension.setter
+    def dimension(self, value: Optional[pulumi.Input[int]]):
+        pulumi.set(self, "dimension", value)
+
+    @property
+    @pulumi.getter
+    def flat(self) -> Optional[pulumi.Input['IndexFieldVectorConfigFlatArgs']]:
+        """
+        Indicates the vector index is a flat index.
+
+        - - -
+        """
+        return pulumi.get(self, "flat")
+
+    @flat.setter
+    def flat(self, value: Optional[pulumi.Input['IndexFieldVectorConfigFlatArgs']]):
+        pulumi.set(self, "flat", value)
+
+
+@pulumi.input_type
+class IndexFieldVectorConfigFlatArgs:
+    def __init__(__self__):
+        pass
+
 

pulumi_gcp/firestore/document.py

@@ -295,8 +295,6 @@ class Document(pulumi.CustomResource):
         `appengine.Application` resource with `database_type` set to
         `"CLOUD_FIRESTORE"`. Your Firestore location will be the same as
         the App Engine location specified.
-        Note: The surface does not support configurable database id. Only `(default)`
-        is allowed for the database parameter.
 
         ## Example Usage
 
@@ -419,8 +417,6 @@ class Document(pulumi.CustomResource):
         `appengine.Application` resource with `database_type` set to
         `"CLOUD_FIRESTORE"`. Your Firestore location will be the same as
         the App Engine location specified.
-        Note: The surface does not support configurable database id. Only `(default)`
-        is allowed for the database parameter.
 
         ## Example Usage
 

pulumi_gcp/firestore/index.py

@@ -25,12 +25,12 @@ class IndexArgs:
         """
         The set of arguments for constructing a Index resource.
         :param pulumi.Input[str] collection: The collection being indexed.
-        :param pulumi.Input[Sequence[pulumi.Input['IndexFieldArgs']]] fields: The fields supported by this index. The last 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 direction as that of the last field defined. If the final field
-               in a composite index is not directional, the `__name__` will be
-               ordered `"ASCENDING"` (unless explicitly specified otherwise).
+        :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
+               direction as that of the last field defined. If the final field in a
+               composite index is not directional, the `__name__` will be ordered
+               `"ASCENDING"` (unless explicitly specified otherwise).
                Structure is documented below.
         :param pulumi.Input[str] api_scope: The API scope at which a query is run.
                Default value is `ANY_API`.
@@ -69,12 +69,12 @@ class IndexArgs:
     @pulumi.getter
     def fields(self) -> pulumi.Input[Sequence[pulumi.Input['IndexFieldArgs']]]:
         """
-        The fields supported by this index. The last 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 direction as that of the last field defined. If the final field
-        in a composite index is not directional, the `__name__` will be
-        ordered `"ASCENDING"` (unless explicitly specified otherwise).
+        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
+        direction as that of the last field defined. If the final field in a
+        composite index is not directional, the `__name__` will be ordered
+        `"ASCENDING"` (unless explicitly specified otherwise).
         Structure is documented below.
         """
         return pulumi.get(self, "fields")
@@ -154,12 +154,12 @@ class _IndexState:
                Possible values are: `ANY_API`, `DATASTORE_MODE_API`.
         :param pulumi.Input[str] collection: The collection being indexed.
         :param pulumi.Input[str] database: The Firestore database id. Defaults to `"(default)"`.
-        :param pulumi.Input[Sequence[pulumi.Input['IndexFieldArgs']]] fields: The fields supported by this index. The last 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 direction as that of the last field defined. If the final field
-               in a composite index is not directional, the `__name__` will be
-               ordered `"ASCENDING"` (unless explicitly specified otherwise).
+        :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
+               direction as that of the last field defined. If the final field in a
+               composite index is not directional, the `__name__` will be ordered
+               `"ASCENDING"` (unless explicitly specified otherwise).
                Structure is documented below.
         :param pulumi.Input[str] name: A server defined name for this index. Format:
                `projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/indexes/{{server_generated_id}}`
@@ -226,12 +226,12 @@ class _IndexState:
     @pulumi.getter
     def fields(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['IndexFieldArgs']]]]:
         """
-        The fields supported by this index. The last 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 direction as that of the last field defined. If the final field
-        in a composite index is not directional, the `__name__` will be
-        ordered `"ASCENDING"` (unless explicitly specified otherwise).
+        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
+        direction as that of the last field defined. If the final field in a
+        composite index is not directional, the `__name__` will be ordered
+        `"ASCENDING"` (unless explicitly specified otherwise).
         Structure is documented below.
         """
         return pulumi.get(self, "fields")
@@ -376,6 +376,43 @@ class Index(pulumi.CustomResource):
             ])
         ```
         <!--End PulumiCodeChooser -->
+        ### Firestore Index Vector
+
+        <!--Start PulumiCodeChooser -->
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+
+        database = gcp.firestore.Database("database",
+            project="my-project-name",
+            name="database-id-vector",
+            location_id="nam5",
+            type="FIRESTORE_NATIVE",
+            delete_protection_state="DELETE_PROTECTION_DISABLED",
+            deletion_policy="DELETE")
+        my_index = gcp.firestore.Index("my-index",
+            project="my-project-name",
+            database=database.name,
+            collection="atestcollection",
+            fields=[
+                gcp.firestore.IndexFieldArgs(
+                    field_path="field_name",
+                    order="ASCENDING",
+                ),
+                gcp.firestore.IndexFieldArgs(
+                    field_path="__name__",
+                    order="ASCENDING",
+                ),
+                gcp.firestore.IndexFieldArgs(
+                    field_path="description",
+                    vector_config=gcp.firestore.IndexFieldVectorConfigArgs(
+                        dimension=128,
+                        flat=gcp.firestore.IndexFieldVectorConfigFlatArgs(),
+                    ),
+                ),
+            ])
+        ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
@@ -396,12 +433,12 @@ class Index(pulumi.CustomResource):
                Possible values are: `ANY_API`, `DATASTORE_MODE_API`.
         :param pulumi.Input[str] collection: The collection being indexed.
         :param pulumi.Input[str] database: The Firestore database id. Defaults to `"(default)"`.
-        :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['IndexFieldArgs']]]] fields: The fields supported by this index. The last 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 direction as that of the last field defined. If the final field
-               in a composite index is not directional, the `__name__` will be
-               ordered `"ASCENDING"` (unless explicitly specified otherwise).
+        :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['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
+               direction as that of the last field defined. If the final field in a
+               composite index is not directional, the `__name__` will be ordered
+               `"ASCENDING"` (unless explicitly specified otherwise).
                Structure is documented below.
         :param pulumi.Input[str] project: The ID of the project in which the resource belongs.
                If it is not provided, the provider project is used.
@@ -498,6 +535,43 @@ class Index(pulumi.CustomResource):
             ])
         ```
         <!--End PulumiCodeChooser -->
+        ### Firestore Index Vector
+
+        <!--Start PulumiCodeChooser -->
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+
+        database = gcp.firestore.Database("database",
+            project="my-project-name",
+            name="database-id-vector",
+            location_id="nam5",
+            type="FIRESTORE_NATIVE",
+            delete_protection_state="DELETE_PROTECTION_DISABLED",
+            deletion_policy="DELETE")
+        my_index = gcp.firestore.Index("my-index",
+            project="my-project-name",
+            database=database.name,
+            collection="atestcollection",
+            fields=[
+                gcp.firestore.IndexFieldArgs(
+                    field_path="field_name",
+                    order="ASCENDING",
+                ),
+                gcp.firestore.IndexFieldArgs(
+                    field_path="__name__",
+                    order="ASCENDING",
+                ),
+                gcp.firestore.IndexFieldArgs(
+                    field_path="description",
+                    vector_config=gcp.firestore.IndexFieldVectorConfigArgs(
+                        dimension=128,
+                        flat=gcp.firestore.IndexFieldVectorConfigFlatArgs(),
+                    ),
+                ),
+            ])
+        ```
+        <!--End PulumiCodeChooser -->
 
         ## Import
 
@@ -581,12 +655,12 @@ class Index(pulumi.CustomResource):
                Possible values are: `ANY_API`, `DATASTORE_MODE_API`.
         :param pulumi.Input[str] collection: The collection being indexed.
         :param pulumi.Input[str] database: The Firestore database id. Defaults to `"(default)"`.
-        :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['IndexFieldArgs']]]] fields: The fields supported by this index. The last 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 direction as that of the last field defined. If the final field
-               in a composite index is not directional, the `__name__` will be
-               ordered `"ASCENDING"` (unless explicitly specified otherwise).
+        :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['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
+               direction as that of the last field defined. If the final field in a
+               composite index is not directional, the `__name__` will be ordered
+               `"ASCENDING"` (unless explicitly specified otherwise).
                Structure is documented below.
         :param pulumi.Input[str] name: A server defined name for this index. Format:
                `projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/indexes/{{server_generated_id}}`
@@ -639,12 +713,12 @@ class Index(pulumi.CustomResource):
     @pulumi.getter
     def fields(self) -> pulumi.Output[Sequence['outputs.IndexField']]:
         """
-        The fields supported by this index. The last 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 direction as that of the last field defined. If the final field
-        in a composite index is not directional, the `__name__` will be
-        ordered `"ASCENDING"` (unless explicitly specified otherwise).
+        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
+        direction as that of the last field defined. If the final field in a
+        composite index is not directional, the `__name__` will be ordered
+        `"ASCENDING"` (unless explicitly specified otherwise).
         Structure is documented below.
         """
         return pulumi.get(self, "fields")

pulumi_gcp/firestore/outputs.py

@@ -18,6 +18,8 @@ __all__ = [
     'FieldIndexConfigIndex',
     'FieldTtlConfig',
     'IndexField',
+    'IndexFieldVectorConfig',
+    'IndexFieldVectorConfigFlat',
 ]
 
 @pulumi.output_type
@@ -255,6 +257,8 @@ class IndexField(dict):
             suggest = "array_config"
         elif key == "fieldPath":
             suggest = "field_path"
+        elif key == "vectorConfig":
+            suggest = "vector_config"
 
         if suggest:
             pulumi.log.warn(f"Key '{key}' not found in IndexField. Access the value via the '{suggest}' property getter instead.")
@@ -270,17 +274,19 @@ class IndexField(dict):
     def __init__(__self__, *,
                  array_config: Optional[str] = None,
                  field_path: Optional[str] = None,
-                 order: Optional[str] = None):
+                 order: Optional[str] = None,
+                 vector_config: Optional['outputs.IndexFieldVectorConfig'] = None):
         """
-        :param str array_config: Indicates that this field supports operations on arrayValues. Only one of `order` and `arrayConfig` can
-               be specified.
+        :param str array_config: Indicates that this field supports operations on arrayValues. Only one of `order`, `arrayConfig`, and
+               `vectorConfig` can be specified.
                Possible values are: `CONTAINS`.
-               
-               - - -
         :param str field_path: Name of the field.
         :param str order: Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
-               Only one of `order` and `arrayConfig` can be specified.
+               Only one of `order`, `arrayConfig`, and `vectorConfig` can be specified.
                Possible values are: `ASCENDING`, `DESCENDING`.
+        :param 'IndexFieldVectorConfigArgs' vector_config: Indicates that this field supports vector search operations. Only one of `order`, `arrayConfig`, and
+               `vectorConfig` can be specified. Vector Fields should come after the field path `__name__`.
+               Structure is documented below.
         """
         if array_config is not None:
             pulumi.set(__self__, "array_config", array_config)
@@ -288,16 +294,16 @@ class IndexField(dict):
             pulumi.set(__self__, "field_path", field_path)
         if order is not None:
             pulumi.set(__self__, "order", order)
+        if vector_config is not None:
+            pulumi.set(__self__, "vector_config", vector_config)
 
     @property
     @pulumi.getter(name="arrayConfig")
     def array_config(self) -> Optional[str]:
         """
-        Indicates that this field supports operations on arrayValues. Only one of `order` and `arrayConfig` can
-        be specified.
+        Indicates that this field supports operations on arrayValues. Only one of `order`, `arrayConfig`, and
+        `vectorConfig` can be specified.
         Possible values are: `CONTAINS`.
-
-        - - -
         """
         return pulumi.get(self, "array_config")
 
@@ -314,9 +320,62 @@ class IndexField(dict):
     def order(self) -> Optional[str]:
         """
         Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
-        Only one of `order` and `arrayConfig` can be specified.
+        Only one of `order`, `arrayConfig`, and `vectorConfig` can be specified.
         Possible values are: `ASCENDING`, `DESCENDING`.
         """
         return pulumi.get(self, "order")
 
+    @property
+    @pulumi.getter(name="vectorConfig")
+    def vector_config(self) -> Optional['outputs.IndexFieldVectorConfig']:
+        """
+        Indicates that this field supports vector search operations. Only one of `order`, `arrayConfig`, and
+        `vectorConfig` can be specified. Vector Fields should come after the field path `__name__`.
+        Structure is documented below.
+        """
+        return pulumi.get(self, "vector_config")
+
+
+@pulumi.output_type
+class IndexFieldVectorConfig(dict):
+    def __init__(__self__, *,
+                 dimension: Optional[int] = None,
+                 flat: Optional['outputs.IndexFieldVectorConfigFlat'] = None):
+        """
+        :param 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)
+        if flat is not None:
+            pulumi.set(__self__, "flat", flat)
+
+    @property
+    @pulumi.getter
+    def dimension(self) -> Optional[int]:
+        """
+        The resulting index will only include vectors of this dimension, and can be used for vector search
+        with the same dimension.
+        """
+        return pulumi.get(self, "dimension")
+
+    @property
+    @pulumi.getter
+    def flat(self) -> Optional['outputs.IndexFieldVectorConfigFlat']:
+        """
+        Indicates the vector index is a flat index.
+
+        - - -
+        """
+        return pulumi.get(self, "flat")
+
+
+@pulumi.output_type
+class IndexFieldVectorConfigFlat(dict):
+    def __init__(__self__):
+        pass
+