IndexArgs constructor

const IndexArgs({
  1. Input<IndexApiScope>? apiScope,
  2. required Input<String> collectionGroupId,
  3. required Input<String> databaseId,
  4. Input<List<GoogleFirestoreAdminV1IndexField>>? fields,
  5. Input<String>? project,
  6. 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.

Implementation

const IndexArgs({
  this.apiScope,
  required this.collectionGroupId,
  required this.databaseId,
  this.fields,
  this.project,
  this.queryScope,
});