Cloud Firestore V1 Client - Class ListenRequest (1.38.0)

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

A request for Firestore.Listen

Generated from protobuf message google.firestore.v1.ListenRequest

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ database string

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

↳ add_target Google\Cloud\Firestore\V1\Target

A target to add to this stream.

↳ remove_target int

The ID of a target to remove from this stream.

↳ labels array|Google\Protobuf\Internal\MapField

Labels associated with this target change.

getDatabase

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

Returns
TypeDescription
string

setDatabase

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAddTarget

A target to add to this stream.

Returns
TypeDescription
Google\Cloud\Firestore\V1\Target|null

hasAddTarget

setAddTarget

A target to add to this stream.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\Target
Returns
TypeDescription
$this

getRemoveTarget

The ID of a target to remove from this stream.

Returns
TypeDescription
int

hasRemoveTarget

setRemoveTarget

The ID of a target to remove from this stream.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getLabels

Labels associated with this target change.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Labels associated with this target change.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getTargetChange

Returns
TypeDescription
string