Reference documentation and code samples for the Cloud Firestore V1 Client class IndexField.
A field in an index.
The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
Generated from protobuf message google.firestore.admin.v1.Index.IndexField
Namespace
Google \ Cloud \ Firestore \ Admin \ V1 \ IndexMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ field_path
string
Can be name. For single field indexes, this must match the name of the field or may be omitted.
↳ order
int
Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
↳ array_config
int
Indicates that this field supports operations on array_value
s.
getFieldPath
Can be name.
For single field indexes, this must match the name of the field or may be omitted.
string
setFieldPath
Can be name.
For single field indexes, this must match the name of the field or may be omitted.
var
string
$this
getOrder
Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
int
hasOrder
setOrder
Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
var
int
$this
getArrayConfig
Indicates that this field supports operations on array_value
s.
int
hasArrayConfig
setArrayConfig
Indicates that this field supports operations on array_value
s.
var
int
$this
getValueMode
string
