Reference documentation and code samples for the Cloud Firestore V1beta1 Client class Target.
A specification of a set of documents to listen to.
Generated from protobuf message google.firestore.v1beta1.Target
Namespace
Google \ Cloud \ Firestore \ V1beta1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ query
↳ documents
Google\Cloud\Firestore\V1beta1\Target\DocumentsTarget
A target specified by a set of document names.
↳ resume_token
string
A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail.
↳ read_time
Google\Protobuf\Timestamp
Start listening after a specific read_time
. The client must know the state of matching documents at this time.
↳ target_id
int
The target ID that identifies the target on the stream. Must be a positive number and non-zero.
↳ once
bool
If the target should be removed once it is current and consistent.
getQuery
A target specified by a query.
setQuery
A target specified by a query.
$this
getDocuments
A target specified by a set of document names.
setDocuments
A target specified by a set of document names.
$this
getResumeToken
A resume token from a prior TargetChange for an identical target.
Using a resume token with a different target is unsupported and may fail.
string
setResumeToken
A resume token from a prior TargetChange for an identical target.
Using a resume token with a different target is unsupported and may fail.
var
string
$this
getReadTime
Start listening after a specific read_time
.
The client must know the state of matching documents at this time.
setReadTime
Start listening after a specific read_time
.
The client must know the state of matching documents at this time.
$this
getTargetId
The target ID that identifies the target on the stream. Must be a positive number and non-zero.
int
setTargetId
The target ID that identifies the target on the stream. Must be a positive number and non-zero.
var
int
$this
getOnce
If the target should be removed once it is current and consistent.
bool
setOnce
If the target should be removed once it is current and consistent.
var
bool
$this
getTargetType
string
getResumeType
string