Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::Target.
A specification of a set of documents to listen to.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#documents
def documents() -> ::Google::Cloud::Firestore::V1::Target::DocumentsTarget
Returns
- (::Google::Cloud::Firestore::V1::Target::DocumentsTarget) — A target specified by a set of document names.
#documents=
def documents=(value) -> ::Google::Cloud::Firestore::V1::Target::DocumentsTarget
Parameter
- value (::Google::Cloud::Firestore::V1::Target::DocumentsTarget) — A target specified by a set of document names.
Returns
- (::Google::Cloud::Firestore::V1::Target::DocumentsTarget) — A target specified by a set of document names.
#once
def once() -> ::Boolean
Returns
- (::Boolean) — If the target should be removed once it is current and consistent.
#once=
def once=(value) -> ::Boolean
Parameter
- value (::Boolean) — If the target should be removed once it is current and consistent.
Returns
- (::Boolean) — If the target should be removed once it is current and consistent.
#query
def query() -> ::Google::Cloud::Firestore::V1::Target::QueryTarget
Returns
- (::Google::Cloud::Firestore::V1::Target::QueryTarget) — A target specified by a query.
#query=
def query=(value) -> ::Google::Cloud::Firestore::V1::Target::QueryTarget
Parameter
- value (::Google::Cloud::Firestore::V1::Target::QueryTarget) — A target specified by a query.
Returns
- (::Google::Cloud::Firestore::V1::Target::QueryTarget) — A target specified by a query.
#read_time
def read_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::Google::Protobuf::Timestamp) — Start listening after a specific
read_time.The client must know the state of matching documents at this time.
#read_time=
def read_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
-
value (::Google::Protobuf::Timestamp) — Start listening after a specific
read_time.The client must know the state of matching documents at this time.
Returns
-
(::Google::Protobuf::Timestamp) — Start listening after a specific
read_time.The client must know the state of matching documents at this time.
#resume_token
def resume_token() -> ::String
Returns
-
(::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.
#resume_token=
def resume_token=(value) -> ::String
Parameter
-
value (::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.
Returns
-
(::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.
#target_id
def target_id() -> ::Integer
Returns
- (::Integer) — The target ID that identifies the target on the stream. Must be a positive number and non-zero.
#target_id=
def target_id=(value) -> ::Integer
Parameter
- value (::Integer) — The target ID that identifies the target on the stream. Must be a positive number and non-zero.
Returns
- (::Integer) — The target ID that identifies the target on the stream. Must be a positive number and non-zero.