Cloud Firestore V1beta1 Client - Class Precondition (1.46.0)

Reference documentation and code samples for the Cloud Firestore V1beta1 Client class Precondition.

A precondition on a document, used for conditional operations.

Generated from protobuf message google.firestore.v1beta1.Precondition

Namespace

Google \ Cloud \ Firestore \ V1beta1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ exists
bool

When set to true , the target document must exist. When set to false , the target document must not exist.

↳ update_time
Google\Protobuf\Timestamp

When set, the target document must exist and have been last updated at that time.

getExists

When set to true , the target document must exist.

When set to false , the target document must not exist.

Returns
Type
Description
bool

setExists

When set to true , the target document must exist.

When set to false , the target document must not exist.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getUpdateTime

When set, the target document must exist and have been last updated at that time.

Returns
Type
Description

setUpdateTime

When set, the target document must exist and have been last updated at that time.

Parameter
Name
Description
Returns
Type
Description
$this

getConditionType

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