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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ vector_config |
Google\Cloud\Firestore\Admin\V1\Index\IndexField\VectorConfig
Indicates that this field supports nearest neighbor and distance operations on vector. |
getFieldPath
Can be name.
For single field indexes, this must match the name of the field or may be omitted.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFieldPath
Can be name.
For single field indexes, this must match the name of the field or may be omitted.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrder
Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasOrder
setOrder
Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getArrayConfig
Indicates that this field supports operations on array_values.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasArrayConfig
setArrayConfig
Indicates that this field supports operations on array_values.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVectorConfig
Indicates that this field supports nearest neighbor and distance operations on vector.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\Admin\V1\Index\IndexField\VectorConfig|null |
|
hasVectorConfig
setVectorConfig
Indicates that this field supports nearest neighbor and distance operations on vector.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\Admin\V1\Index\IndexField\VectorConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValueMode
| Returns | |
|---|---|
| Type | Description |
string |
|