Reference documentation and code samples for the Cloud Firestore V1 Client class FieldFilter.
A filter on a specific field.
Generated from protobuf message google.firestore.v1.StructuredQuery.FieldFilter
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field |
Google\Cloud\Firestore\V1\StructuredQuery\FieldReference
The field to filter by. |
↳ op |
int
The operator to filter by. |
↳ value |
Google\Cloud\Firestore\V1\Value
The value to compare to. |
getField
The field to filter by.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\StructuredQuery\FieldReference|null | |
hasField
clearField
setField
The field to filter by.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\StructuredQuery\FieldReference
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOp
The operator to filter by.
| Returns | |
|---|---|
| Type | Description |
int | |
setOp
The operator to filter by.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValue
The value to compare to.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\Value|null | |
hasValue
clearValue
setValue
The value to compare to.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |