GoogleFirestoreAdminV1Index class
Cloud Firestore indexes enable simple and complex queries against documents in a database.
Constructors
Properties
-
fields
↔ List<
GoogleFirestoreAdminV1IndexField> -
The fields supported by this index. For composite indexes, this is always
2 or more 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.read / write - hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- name ↔ String
-
Output only. 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.read / write - 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.
Possible string values are: [...]
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- state ↔ String
-
Output only. The serving state of the index.
Possible string values are: [...]
read / write
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toJson(
) → Map< String, Object> -
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited