Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. firestore
  5. firestore/v1
  6. Index

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.firestore/v1.Index

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. Auto-naming is currently not supported for this resource.

    Create Index Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Index(name: string, args: IndexArgs, opts?: CustomResourceOptions);
    @overload
def Index(resource_name: str,
          args: IndexArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Index(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          collection_group_id: Optional[str] = None,
          database_id: Optional[str] = None,
          api_scope: Optional[IndexApiScope] = None,
          fields: Optional[Sequence[GoogleFirestoreAdminV1IndexFieldArgs]] = None,
          project: Optional[str] = None,
          query_scope: Optional[IndexQueryScope] = None)
    func NewIndex(ctx *Context, name string, args IndexArgs, opts ...ResourceOption) (*Index, error)
    public Index(string name, IndexArgs args, CustomResourceOptions? opts = null)
    public Index(String name, IndexArgs args)
public Index(String name, IndexArgs args, CustomResourceOptions options)

    type: google-native:firestore/v1:Index
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IndexArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleindexResourceResourceFromFirestorev1 = new GoogleNative.Firestore.V1.Index("exampleindexResourceResourceFromFirestorev1", new()
{
    CollectionGroupId = "string",
    DatabaseId = "string",
    ApiScope = GoogleNative.Firestore.V1.IndexApiScope.AnyApi,
    Fields = new[]
    {
        new GoogleNative.Firestore.V1.Inputs.GoogleFirestoreAdminV1IndexFieldArgs
        {
            ArrayConfig = GoogleNative.Firestore.V1.GoogleFirestoreAdminV1IndexFieldArrayConfig.ArrayConfigUnspecified,
            FieldPath = "string",
            Order = GoogleNative.Firestore.V1.GoogleFirestoreAdminV1IndexFieldOrder.OrderUnspecified,
            VectorConfig = new GoogleNative.Firestore.V1.Inputs.GoogleFirestoreAdminV1VectorConfigArgs
            {
                Dimension = 0,
                Flat = null,
            },
        },
    },
    Project = "string",
    QueryScope = GoogleNative.Firestore.V1.IndexQueryScope.QueryScopeUnspecified,
});

    example, err := firestore.NewIndex(ctx, "exampleindexResourceResourceFromFirestorev1", &firestore.IndexArgs{
	CollectionGroupId: pulumi.String("string"),
	DatabaseId:        pulumi.String("string"),
	ApiScope:          firestore.IndexApiScopeAnyApi,
	Fields: firestore.GoogleFirestoreAdminV1IndexFieldArray{
		&firestore.GoogleFirestoreAdminV1IndexFieldArgs{
			ArrayConfig: firestore.GoogleFirestoreAdminV1IndexFieldArrayConfigArrayConfigUnspecified,
			FieldPath:   pulumi.String("string"),
			Order:       firestore.GoogleFirestoreAdminV1IndexFieldOrderOrderUnspecified,
			VectorConfig: &firestore.GoogleFirestoreAdminV1VectorConfigArgs{
				Dimension: pulumi.Int(0),
				Flat:      &firestore.GoogleFirestoreAdminV1FlatIndexArgs{},
			},
		},
	},
	Project:    pulumi.String("string"),
	QueryScope: firestore.IndexQueryScopeQueryScopeUnspecified,
})

    var exampleindexResourceResourceFromFirestorev1 = new com.pulumi.googlenative.firestore_v1.Index("exampleindexResourceResourceFromFirestorev1", com.pulumi.googlenative.firestore_v1.IndexArgs.builder()
    .collectionGroupId("string")
    .databaseId("string")
    .apiScope("ANY_API")
    .fields(GoogleFirestoreAdminV1IndexFieldArgs.builder()
        .arrayConfig("ARRAY_CONFIG_UNSPECIFIED")
        .fieldPath("string")
        .order("ORDER_UNSPECIFIED")
        .vectorConfig(GoogleFirestoreAdminV1VectorConfigArgs.builder()
            .dimension(0)
            .flat(GoogleFirestoreAdminV1FlatIndexArgs.builder()
                .build())
            .build())
        .build())
    .project("string")
    .queryScope("QUERY_SCOPE_UNSPECIFIED")
    .build());

    exampleindex_resource_resource_from_firestorev1 = google_native.firestore.v1.Index("exampleindexResourceResourceFromFirestorev1",
    collection_group_id="string",
    database_id="string",
    api_scope=google_native.firestore.v1.IndexApiScope.ANY_API,
    fields=[{
        "array_config": google_native.firestore.v1.GoogleFirestoreAdminV1IndexFieldArrayConfig.ARRAY_CONFIG_UNSPECIFIED,
        "field_path": "string",
        "order": google_native.firestore.v1.GoogleFirestoreAdminV1IndexFieldOrder.ORDER_UNSPECIFIED,
        "vector_config": {
            "dimension": 0,
            "flat": {},
        },
    }],
    project="string",
    query_scope=google_native.firestore.v1.IndexQueryScope.QUERY_SCOPE_UNSPECIFIED)

    const exampleindexResourceResourceFromFirestorev1 = new google_native.firestore.v1.Index("exampleindexResourceResourceFromFirestorev1", {
    collectionGroupId: "string",
    databaseId: "string",
    apiScope: google_native.firestore.v1.IndexApiScope.AnyApi,
    fields: [{
        arrayConfig: google_native.firestore.v1.GoogleFirestoreAdminV1IndexFieldArrayConfig.ArrayConfigUnspecified,
        fieldPath: "string",
        order: google_native.firestore.v1.GoogleFirestoreAdminV1IndexFieldOrder.OrderUnspecified,
        vectorConfig: {
            dimension: 0,
            flat: {},
        },
    }],
    project: "string",
    queryScope: google_native.firestore.v1.IndexQueryScope.QueryScopeUnspecified,
});

    type: google-native:firestore/v1:Index
properties:
    apiScope: ANY_API
    collectionGroupId: string
    databaseId: string
    fields:
        - arrayConfig: ARRAY_CONFIG_UNSPECIFIED
          fieldPath: string
          order: ORDER_UNSPECIFIED
          vectorConfig:
            dimension: 0
            flat: {}
    project: string
    queryScope: QUERY_SCOPE_UNSPECIFIED

    Index Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Index resource accepts the following input properties:

    CollectionGroupId string
    DatabaseId string
    ApiScope Pulumi.GoogleNative.Firestore.V1.IndexApiScope
    The API scope supported by this index.
    Fields List<Pulumi.GoogleNative.Firestore.V1.Inputs.GoogleFirestoreAdminV1IndexField>
    The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. 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). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
    Project string
    QueryScope Pulumi.GoogleNative.Firestore.V1.IndexQueryScope
    Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
    CollectionGroupId string
    DatabaseId string
    ApiScope IndexApiScope
    The API scope supported by this index.
    Fields []GoogleFirestoreAdminV1IndexFieldArgs
    The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. 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). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
    Project string
    QueryScope IndexQueryScope
    Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
    collectionGroupId String
    databaseId String
    apiScope IndexApiScope
    The API scope supported by this index.
    fields List<GoogleFirestoreAdminV1IndexField>
    The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. 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). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
    project String
    queryScope IndexQueryScope
    Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
    collectionGroupId string
    databaseId string
    apiScope IndexApiScope
    The API scope supported by this index.
    fields GoogleFirestoreAdminV1IndexField[]
    The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. 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). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
    project string
    queryScope IndexQueryScope
    Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
    collection_group_id str
    database_id str
    api_scope IndexApiScope
    The API scope supported by this index.
    fields Sequence[GoogleFirestoreAdminV1IndexFieldArgs]
    The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. 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). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
    project str
    query_scope IndexQueryScope
    Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
    collectionGroupId String
    databaseId String
    apiScope "ANY_API" | "DATASTORE_MODE_API"
    The API scope supported by this index.
    fields List<Property Map>
    The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. 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). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
    project String
    queryScope "QUERY_SCOPE_UNSPECIFIED" | "COLLECTION" | "COLLECTION_GROUP" | "COLLECTION_RECURSIVE"
    Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Index resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
    State string
    The serving state of the index.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
    State string
    The serving state of the index.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
    state String
    The serving state of the index.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
    state string
    The serving state of the index.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
    state str
    The serving state of the index.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    A server defined name for this index. The form of this name for composite indexes will be: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} For single field indexes, this field will be empty.
    state String
    The serving state of the index.

    Supporting Types

    GoogleFirestoreAdminV1IndexField, GoogleFirestoreAdminV1IndexFieldArgs

    ArrayConfig Pulumi.GoogleNative.Firestore.V1.GoogleFirestoreAdminV1IndexFieldArrayConfig
    Indicates that this field supports operations on array_values.
    FieldPath string
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    Order Pulumi.GoogleNative.Firestore.V1.GoogleFirestoreAdminV1IndexFieldOrder
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    VectorConfig Pulumi.GoogleNative.Firestore.V1.Inputs.GoogleFirestoreAdminV1VectorConfig
    Indicates that this field supports nearest neighbors and distance operations on vector.
    ArrayConfig GoogleFirestoreAdminV1IndexFieldArrayConfig
    Indicates that this field supports operations on array_values.
    FieldPath string
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    Order GoogleFirestoreAdminV1IndexFieldOrder
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    VectorConfig GoogleFirestoreAdminV1VectorConfig
    Indicates that this field supports nearest neighbors and distance operations on vector.
    arrayConfig GoogleFirestoreAdminV1IndexFieldArrayConfig
    Indicates that this field supports operations on array_values.
    fieldPath String
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    order GoogleFirestoreAdminV1IndexFieldOrder
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    vectorConfig GoogleFirestoreAdminV1VectorConfig
    Indicates that this field supports nearest neighbors and distance operations on vector.
    arrayConfig GoogleFirestoreAdminV1IndexFieldArrayConfig
    Indicates that this field supports operations on array_values.
    fieldPath string
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    order GoogleFirestoreAdminV1IndexFieldOrder
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    vectorConfig GoogleFirestoreAdminV1VectorConfig
    Indicates that this field supports nearest neighbors and distance operations on vector.
    array_config GoogleFirestoreAdminV1IndexFieldArrayConfig
    Indicates that this field supports operations on array_values.
    field_path str
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    order GoogleFirestoreAdminV1IndexFieldOrder
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    vector_config GoogleFirestoreAdminV1VectorConfig
    Indicates that this field supports nearest neighbors and distance operations on vector.
    arrayConfig "ARRAY_CONFIG_UNSPECIFIED" | "CONTAINS"
    Indicates that this field supports operations on array_values.
    fieldPath String
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    order "ORDER_UNSPECIFIED" | "ASCENDING" | "DESCENDING"
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    vectorConfig Property Map
    Indicates that this field supports nearest neighbors and distance operations on vector.

    GoogleFirestoreAdminV1IndexFieldArrayConfig, GoogleFirestoreAdminV1IndexFieldArrayConfigArgs

    ArrayConfigUnspecified
    ARRAY_CONFIG_UNSPECIFIEDThe index does not support additional array queries.
    Contains
    CONTAINSThe index supports array containment queries.
    GoogleFirestoreAdminV1IndexFieldArrayConfigArrayConfigUnspecified
    ARRAY_CONFIG_UNSPECIFIEDThe index does not support additional array queries.
    GoogleFirestoreAdminV1IndexFieldArrayConfigContains
    CONTAINSThe index supports array containment queries.
    ArrayConfigUnspecified
    ARRAY_CONFIG_UNSPECIFIEDThe index does not support additional array queries.
    Contains
    CONTAINSThe index supports array containment queries.
    ArrayConfigUnspecified
    ARRAY_CONFIG_UNSPECIFIEDThe index does not support additional array queries.
    Contains
    CONTAINSThe index supports array containment queries.
    ARRAY_CONFIG_UNSPECIFIED
    ARRAY_CONFIG_UNSPECIFIEDThe index does not support additional array queries.
    CONTAINS
    CONTAINSThe index supports array containment queries.
    "ARRAY_CONFIG_UNSPECIFIED"
    ARRAY_CONFIG_UNSPECIFIEDThe index does not support additional array queries.
    "CONTAINS"
    CONTAINSThe index supports array containment queries.

    GoogleFirestoreAdminV1IndexFieldOrder, GoogleFirestoreAdminV1IndexFieldOrderArgs

    OrderUnspecified
    ORDER_UNSPECIFIEDThe ordering is unspecified. Not a valid option.
    Ascending
    ASCENDINGThe field is ordered by ascending field value.
    Descending
    DESCENDINGThe field is ordered by descending field value.
    GoogleFirestoreAdminV1IndexFieldOrderOrderUnspecified
    ORDER_UNSPECIFIEDThe ordering is unspecified. Not a valid option.
    GoogleFirestoreAdminV1IndexFieldOrderAscending
    ASCENDINGThe field is ordered by ascending field value.
    GoogleFirestoreAdminV1IndexFieldOrderDescending
    DESCENDINGThe field is ordered by descending field value.
    OrderUnspecified
    ORDER_UNSPECIFIEDThe ordering is unspecified. Not a valid option.
    Ascending
    ASCENDINGThe field is ordered by ascending field value.
    Descending
    DESCENDINGThe field is ordered by descending field value.
    OrderUnspecified
    ORDER_UNSPECIFIEDThe ordering is unspecified. Not a valid option.
    Ascending
    ASCENDINGThe field is ordered by ascending field value.
    Descending
    DESCENDINGThe field is ordered by descending field value.
    ORDER_UNSPECIFIED
    ORDER_UNSPECIFIEDThe ordering is unspecified. Not a valid option.
    ASCENDING
    ASCENDINGThe field is ordered by ascending field value.
    DESCENDING
    DESCENDINGThe field is ordered by descending field value.
    "ORDER_UNSPECIFIED"
    ORDER_UNSPECIFIEDThe ordering is unspecified. Not a valid option.
    "ASCENDING"
    ASCENDINGThe field is ordered by ascending field value.
    "DESCENDING"
    DESCENDINGThe field is ordered by descending field value.

    GoogleFirestoreAdminV1IndexFieldResponse, GoogleFirestoreAdminV1IndexFieldResponseArgs

    ArrayConfig string
    Indicates that this field supports operations on array_values.
    FieldPath string
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    Order string
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    VectorConfig Pulumi.GoogleNative.Firestore.V1.Inputs.GoogleFirestoreAdminV1VectorConfigResponse
    Indicates that this field supports nearest neighbors and distance operations on vector.
    ArrayConfig string
    Indicates that this field supports operations on array_values.
    FieldPath string
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    Order string
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    VectorConfig GoogleFirestoreAdminV1VectorConfigResponse
    Indicates that this field supports nearest neighbors and distance operations on vector.
    arrayConfig String
    Indicates that this field supports operations on array_values.
    fieldPath String
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    order String
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    vectorConfig GoogleFirestoreAdminV1VectorConfigResponse
    Indicates that this field supports nearest neighbors and distance operations on vector.
    arrayConfig string
    Indicates that this field supports operations on array_values.
    fieldPath string
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    order string
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    vectorConfig GoogleFirestoreAdminV1VectorConfigResponse
    Indicates that this field supports nearest neighbors and distance operations on vector.
    array_config str
    Indicates that this field supports operations on array_values.
    field_path str
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    order str
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    vector_config GoogleFirestoreAdminV1VectorConfigResponse
    Indicates that this field supports nearest neighbors and distance operations on vector.
    arrayConfig String
    Indicates that this field supports operations on array_values.
    fieldPath String
    Can be name. For single field indexes, this must match the name of the field or may be omitted.
    order String
    Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
    vectorConfig Property Map
    Indicates that this field supports nearest neighbors and distance operations on vector.

    GoogleFirestoreAdminV1VectorConfig, GoogleFirestoreAdminV1VectorConfigArgs

    Dimension int
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    Flat Pulumi.GoogleNative.Firestore.V1.Inputs.GoogleFirestoreAdminV1FlatIndex
    Indicates the vector index is a flat index.
    Dimension int
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    Flat GoogleFirestoreAdminV1FlatIndex
    Indicates the vector index is a flat index.
    dimension Integer
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    flat GoogleFirestoreAdminV1FlatIndex
    Indicates the vector index is a flat index.
    dimension number
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    flat GoogleFirestoreAdminV1FlatIndex
    Indicates the vector index is a flat index.
    dimension int
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    flat GoogleFirestoreAdminV1FlatIndex
    Indicates the vector index is a flat index.
    dimension Number
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    flat Property Map
    Indicates the vector index is a flat index.

    GoogleFirestoreAdminV1VectorConfigResponse, GoogleFirestoreAdminV1VectorConfigResponseArgs

    Dimension int
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    Flat Pulumi.GoogleNative.Firestore.V1.Inputs.GoogleFirestoreAdminV1FlatIndexResponse
    Indicates the vector index is a flat index.
    Dimension int
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    Flat GoogleFirestoreAdminV1FlatIndexResponse
    Indicates the vector index is a flat index.
    dimension Integer
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    flat GoogleFirestoreAdminV1FlatIndexResponse
    Indicates the vector index is a flat index.
    dimension number
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    flat GoogleFirestoreAdminV1FlatIndexResponse
    Indicates the vector index is a flat index.
    dimension int
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    flat GoogleFirestoreAdminV1FlatIndexResponse
    Indicates the vector index is a flat index.
    dimension Number
    The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.
    flat Property Map
    Indicates the vector index is a flat index.

    IndexApiScope, IndexApiScopeArgs

    AnyApi
    ANY_APIThe index can only be used by the Firestore Native query API. This is the default.
    DatastoreModeApi
    DATASTORE_MODE_APIThe index can only be used by the Firestore in Datastore Mode query API.
    IndexApiScopeAnyApi
    ANY_APIThe index can only be used by the Firestore Native query API. This is the default.
    IndexApiScopeDatastoreModeApi
    DATASTORE_MODE_APIThe index can only be used by the Firestore in Datastore Mode query API.
    AnyApi
    ANY_APIThe index can only be used by the Firestore Native query API. This is the default.
    DatastoreModeApi
    DATASTORE_MODE_APIThe index can only be used by the Firestore in Datastore Mode query API.
    AnyApi
    ANY_APIThe index can only be used by the Firestore Native query API. This is the default.
    DatastoreModeApi
    DATASTORE_MODE_APIThe index can only be used by the Firestore in Datastore Mode query API.
    ANY_API
    ANY_APIThe index can only be used by the Firestore Native query API. This is the default.
    DATASTORE_MODE_API
    DATASTORE_MODE_APIThe index can only be used by the Firestore in Datastore Mode query API.
    "ANY_API"
    ANY_APIThe index can only be used by the Firestore Native query API. This is the default.
    "DATASTORE_MODE_API"
    DATASTORE_MODE_APIThe index can only be used by the Firestore in Datastore Mode query API.

    IndexQueryScope, IndexQueryScopeArgs

    QueryScopeUnspecified
    QUERY_SCOPE_UNSPECIFIEDThe query scope is unspecified. Not a valid option.
    Collection
    COLLECTIONIndexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection id specified by the index.
    CollectionGroup
    COLLECTION_GROUPIndexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.
    CollectionRecursive
    COLLECTION_RECURSIVEInclude all the collections's ancestor in the index. Only available for Datastore Mode databases.
    IndexQueryScopeQueryScopeUnspecified
    QUERY_SCOPE_UNSPECIFIEDThe query scope is unspecified. Not a valid option.
    IndexQueryScopeCollection
    COLLECTIONIndexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection id specified by the index.
    IndexQueryScopeCollectionGroup
    COLLECTION_GROUPIndexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.
    IndexQueryScopeCollectionRecursive
    COLLECTION_RECURSIVEInclude all the collections's ancestor in the index. Only available for Datastore Mode databases.
    QueryScopeUnspecified
    QUERY_SCOPE_UNSPECIFIEDThe query scope is unspecified. Not a valid option.
    Collection
    COLLECTIONIndexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection id specified by the index.
    CollectionGroup
    COLLECTION_GROUPIndexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.
    CollectionRecursive
    COLLECTION_RECURSIVEInclude all the collections's ancestor in the index. Only available for Datastore Mode databases.
    QueryScopeUnspecified
    QUERY_SCOPE_UNSPECIFIEDThe query scope is unspecified. Not a valid option.
    Collection
    COLLECTIONIndexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection id specified by the index.
    CollectionGroup
    COLLECTION_GROUPIndexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.
    CollectionRecursive
    COLLECTION_RECURSIVEInclude all the collections's ancestor in the index. Only available for Datastore Mode databases.
    QUERY_SCOPE_UNSPECIFIED
    QUERY_SCOPE_UNSPECIFIEDThe query scope is unspecified. Not a valid option.
    COLLECTION
    COLLECTIONIndexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection id specified by the index.
    COLLECTION_GROUP
    COLLECTION_GROUPIndexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.
    COLLECTION_RECURSIVE
    COLLECTION_RECURSIVEInclude all the collections's ancestor in the index. Only available for Datastore Mode databases.
    "QUERY_SCOPE_UNSPECIFIED"
    QUERY_SCOPE_UNSPECIFIEDThe query scope is unspecified. Not a valid option.
    "COLLECTION"
    COLLECTIONIndexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection id specified by the index.
    "COLLECTION_GROUP"
    COLLECTION_GROUPIndexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.
    "COLLECTION_RECURSIVE"
    COLLECTION_RECURSIVEInclude all the collections's ancestor in the index. Only available for Datastore Mode databases.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native