Metadata for google.longrunning.Operation
results from FirestoreAdmin.UpdateField
.
JSON representation |
---|
{ "startTime": string, "endTime": string, "field": string, "indexConfigDeltas": [ { object ( |
Fields | |
---|---|
startTime |
The time this operation started. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
endTime |
The time this operation completed. Will be unset if operation still in progress. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
field |
The field resource that this operation is acting on. For example: |
indexConfigDeltas[] |
A list of |
state |
The state of the operation. |
progressDocuments |
The progress, in documents, of this operation. |
progressBytes |
The progress, in bytes, of this operation. |
ttlConfigDelta |
Describes the deltas of TTL configuration. |
IndexConfigDelta
Information about an index configuration change.
JSON representation |
---|
{ "changeType": enum ( |
Fields | |
---|---|
changeType |
Specifies how the index is changing. |
index |
The index being changed. |
Index
Cloud Firestore indexes enable simple and complex queries against documents in a database.
JSON representation |
---|
{ "name": string, "queryScope": enum ( |
Fields | |
---|---|
name |
Output only. A server defined name for this index. The form of this name for composite indexes will be: |
queryScope |
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. |
apiScope |
The API scope supported by this index. |
fields[] |
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 For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. |
state |
Output only. The serving state of the index. |
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 index with MONGODB_COMPATIBLE_API ApiScope. |
shardCount |
Optional. The number of shards for the index. |
IndexField
A field in an index. The fieldPath describes which field is indexed, the value_mode describes how the field value is indexed.
JSON representation |
---|
{ "fieldPath": string, // Union field |
Fields | |
---|---|
fieldPath |
Can be name. For single field indexes, this must match the name of the field or may be omitted. |
Union field value_mode . How the field value is indexed. value_mode can be only one of the following: |
|
order |
Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=. |
arrayConfig |
Indicates that this field supports operations on |
vectorConfig |
Indicates that this field supports nearest neighbor and distance operations on vector. |
VectorConfig
The index configuration to support vector search operations
JSON representation |
---|
{ "dimension": integer, // Union field |
Fields | |
---|---|
dimension |
Required. 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. |
Union field type . The type of index used. type can be only one of the following: |
|
flat |
Indicates the vector index is a flat index. |
FlatIndex
This type has no fields.
An index that stores vectors in a flat data structure, and supports exhaustive search.
TtlConfigDelta
Information about a TTL configuration change.
JSON representation |
---|
{
"changeType": enum ( |
Fields | |
---|---|
changeType |
Specifies how the TTL configuration is changing. |