Reference documentation and code samples for the Cloud Firestore V1 Client class UpdateFieldRequest.
The request for FirestoreAdmin.UpdateField.
Generated from protobuf message google.firestore.admin.v1.UpdateFieldRequest
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field |
Google\Cloud\Firestore\Admin\V1\Field
Required. The field to be updated. |
↳ update_mask |
Google\Protobuf\FieldMask
A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field. |
getField
Required. The field to be updated.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\Admin\V1\Field|null | |
hasField
clearField
setField
Required. The field to be updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\Admin\V1\Field
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateMask
A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasUpdateMask
clearUpdateMask
setUpdateMask
A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
field |
Google\Cloud\Firestore\Admin\V1\Field
Required. The field to be updated. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\Admin\V1\UpdateFieldRequest | |