IndexArgs class

The set of arguments for Index. The set of arguments for Index.

Constructors

IndexArgs({Input<IndexApiScope>? apiScope, required Input<String> collectionGroupId, required Input<String> databaseId, Input<List<GoogleFirestoreAdminV1IndexField>>? fields, Input<String>? project, Input<IndexQueryScope>? queryScope})

Creates a new IndexArgs. apiScope The API scope supported by this index. collectionGroupId Required. databaseId Required. 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 __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 Optional. 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.

const

IndexArgs.fromMap(Map<String, dynamic> map)

factory

Properties

apiScope → Input<IndexApiScope>?

The API scope supported by this index.

final

collectionGroupId → Input<String>

final

databaseId → Input<String>

final

fields → Input<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.

final

hashCode → int

The hash code for this object.

no setter, inherited

project → Input<String>?

final

queryScope → Input<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.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited