DomainIndexField class

Constructors

DomainIndexField({Input<String?>? analysisScheme, Input<String?>? defaultValue, Input<bool?>? facet, Input<bool?>? highlight, required Input<String> name, Input<bool?>? return_, Input<bool?>? search, Input<bool?>? sort, Input<String?>? sourceFields, required Input<String> type})
Creates a new DomainIndexField. analysisScheme The analysis scheme you want to use for a text field. The analysis scheme specifies the language-specific text processing options that are used during indexing. defaultValue The default value for the field. This value is used when no value is specified for the field in the document data. facet You can get facet information by enabling this. highlight You can highlight information. name A unique name for the field. Field names must begin with a letter and be at least 1 and no more than 64 characters long. The allowed characters are: a-z (lower-case letters), 0-9, and _ (underscore). The name score is reserved and cannot be used as a field name. return_ You can enable returning the value of all searchable fields. search You can set whether this index should be searchable or not. sort You can enable the property to be sortable. sourceFields A comma-separated list of source fields to map to the field. Specifying a source field copies data from one field to another, enabling you to use the same source data in different ways by configuring different options for the fields. type The field type. Valid values: date, date-array, double, double-array, int, int-array, literal, literal-array, text, text-array.
const
DomainIndexField.fromMap(Map<String, dynamic> map)
factory

Properties

analysisScheme → Input<String?>?
The analysis scheme you want to use for a text field. The analysis scheme specifies the language-specific text processing options that are used during indexing.
final
defaultValue → Input<String?>?
The default value for the field. This value is used when no value is specified for the field in the document data.
final
facet → Input<bool?>?
You can get facet information by enabling this.
final
hashCode → int
The hash code for this object.
no setterinherited
highlight → Input<bool?>?
You can highlight information.
final
name → Input<String>
A unique name for the field. Field names must begin with a letter and be at least 1 and no more than 64 characters long. The allowed characters are: a-z (lower-case letters), 0-9, and _ (underscore). The name score is reserved and cannot be used as a field name.
final
return_ → Input<bool?>?
You can enable returning the value of all searchable fields.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
You can set whether this index should be searchable or not.
final
sort → Input<bool?>?
You can enable the property to be sortable.
final
sourceFields → Input<String?>?
A comma-separated list of source fields to map to the field. Specifying a source field copies data from one field to another, enabling you to use the same source data in different ways by configuring different options for the fields.
final
type → Input<String>
The field type. Valid values: date, date-array, double, double-array, int, int-array, literal, literal-array, text, text-array.
final

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