Cloud Firestore V1 Client - Class UpdateFieldRequest (1.53.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ field
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
Field |null

hasField

clearField

setField

Required. The field to be updated.

Parameter
Name
Description
var
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

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
Returns
Type
Description
$this

static::build

Parameter
Name
Description
field
Field

Required. The field to be updated.

Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: