google-native.firestore/v1.getIndex

func LookupIndex(ctx *Context, args *LookupIndexArgs, opts ...InvokeOption) (*LookupIndexResult, error)
func LookupIndexOutput(ctx *Context, args *LookupIndexOutputArgs, opts ...InvokeOption) LookupIndexResultOutput

> Note: This function is named LookupIndex in the Go SDK.

CollectionGroupId string

DatabaseId string

IndexId string

Project string

CollectionGroupId string

DatabaseId string

IndexId string

Project string

collectionGroupId String

databaseId String

indexId String

project String

collectionGroupId string

databaseId string

indexId string

project string

collection_group_id str

database_id str

index_id str

project str

collectionGroupId String

databaseId String

indexId String

project String

ApiScope string

The API scope supported by this index.

Fields List<Pulumi.GoogleNative.Firestore.V1.Outputs.GoogleFirestoreAdminV1IndexFieldResponse>

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.

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.

QueryScope string

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.

State string

The serving state of the index.

ApiScope string

The API scope supported by this index.

Fields []GoogleFirestoreAdminV1IndexFieldResponse

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.

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.

QueryScope string

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.

State string

The serving state of the index.

apiScope String

The API scope supported by this index.

fields List<GoogleFirestoreAdminV1IndexFieldResponse>

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.

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.

queryScope String

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.

state String

The serving state of the index.

apiScope string

The API scope supported by this index.

fields GoogleFirestoreAdminV1IndexFieldResponse[]

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.

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.

queryScope string

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.

state string

The serving state of the index.

api_scope str

The API scope supported by this index.

fields Sequence[GoogleFirestoreAdminV1IndexFieldResponse]

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.

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.

query_scope str

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.

state str

The serving state of the index.

apiScope String

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.

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.

queryScope String

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.

state String

The serving state of the index.

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.

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.