Cloud Firestore V1 Client - Class Precondition (1.45.0)

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

A precondition on a document, used for conditional operations.

Generated from protobuf message google.firestore.v1.Precondition

Namespace

Google \ Cloud \ Firestore \ V1

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. Timestamp must be microsecond aligned.

getExists

When set to true, the target document must exist.

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

Returns
Type Description
bool

hasExists

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. Timestamp must be microsecond aligned.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

setUpdateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getConditionType

Returns
Type Description
string