Cloud Firestore V1 Client - Class ExistenceFilter (1.31.0)

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

A digest of all the documents that match a given target.

Generated from protobuf message google.firestore.v1.ExistenceFilter

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ target_id int

The target ID to which this filter applies.

↳ count int

The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target.

getTargetId

The target ID to which this filter applies.

Returns
TypeDescription
int

setTargetId

The target ID to which this filter applies.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCount

The total count of documents that match target_id.

If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target.

Returns
TypeDescription
int

setCount

The total count of documents that match target_id.

If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target.

Parameter
NameDescription
var int
Returns
TypeDescription
$this