IndexingPolicy class
Class representing a container's indexing policy.
Constructors
- IndexingPolicy({IndexingMode indexingMode = IndexingMode.consistent, bool automatic = true})
Properties
- automatic → bool
-
Automatic indexing.
final
-
compositeIndexes
→ List<
List< IndexPath> > -
List of JSON paths for composite indexes. Only scalar values are covered,
so these paths should not include the
/?nor the/*suffix.final -
excludedPaths
→ List<
IndexPath> -
JSON paths to fields that must not be indexed. See also includedPaths.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
includedPaths
→ List<
IndexPath> -
JSON paths to fields that must be indexed. Must end with
/?for scalar fields, or/*to include all sub-nodes.final - indexingMode → IndexingMode
-
Indexing mode. See constants available in IndexingMode.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
spatialIndexes
→ List<
SpatialIndexPath> -
List of JSON paths for spatial indexing.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> - Serializes this instance to a JSON object.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
fromJson(
Map json) → IndexingPolicy -
Deserializes data from JSON object
jsoninto a new IndexingPolicy instance. Handles fieldsindexingMode,includedPaths,excludedPaths,spatialIndexes,compositeIndexes.