GoogleFirestoreAdminV1Index class

Cloud Firestore indexes enable simple and complex queries against documents in a database.

In Standard edition databases, single-field indexes are managed using the google.firestore.admin.v1.Field resource, and composite indexes are managed using the google.firestore.admin.v1.Index resource. In Enterprise edition databases, both single-field and composite indexes are managed using the google.firestore.admin.v1.Index resource.

Constructors

GoogleFirestoreAdminV1Index({String? apiScope, String? density, List<GoogleFirestoreAdminV1IndexField>? fields, bool? multikey, String? name, String? queryScope, GoogleFirestoreAdminV1SearchIndexOptions? searchIndexOptions, int? shardCount, String? state, bool? unique})
GoogleFirestoreAdminV1Index.fromJson(Map json_)

Properties

apiScope ↔ String?
The API scope supported by this index. Possible string values are:
getter/setter pair
density ↔ String?
The density configuration of the index.
getter/setter pair
fields ↔ List<GoogleFirestoreAdminV1IndexField>?
The fields supported by this index.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
multikey ↔ bool?
Whether the index is multikey.
getter/setter pair
name ↔ String?
A server-defined name for this index.
getter/setter pair
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.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchIndexOptions ↔ GoogleFirestoreAdminV1SearchIndexOptions?
Options for search indexes that are at the index definition level.
getter/setter pair
shardCount ↔ int?
The number of shards for the index.
getter/setter pair
state ↔ String?
The serving state of the index.
getter/setter pair
unique ↔ bool?
Whether it is an unique index.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited