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
- (::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
- value (::Google::Cloud::Firestore::V1::Target::DocumentsTarget) — A target specified by a set of document names.
- (::Google::Cloud::Firestore::V1::Target::DocumentsTarget) — A target specified by a set of document names.
#expected_count
def expected_count() -> ::Google::Protobuf::Int32Value
-
(::Google::Protobuf::Int32Value) — The number of documents that last matched the query at the resume token or
read time.
This value is only relevant when a
resume_type
is provided. This value being present and greater than zero signals that the client wantsExistenceFilter.unchanged_names
to be included in the response.
#expected_count=
def expected_count=(value) -> ::Google::Protobuf::Int32Value
-
value (::Google::Protobuf::Int32Value) — The number of documents that last matched the query at the resume token or
read time.
This value is only relevant when a
resume_type
is provided. This value being present and greater than zero signals that the client wantsExistenceFilter.unchanged_names
to be included in the response.
-
(::Google::Protobuf::Int32Value) — The number of documents that last matched the query at the resume token or
read time.
This value is only relevant when a
resume_type
is provided. This value being present and greater than zero signals that the client wantsExistenceFilter.unchanged_names
to be included in the response.
#once
def once() -> ::Boolean
- (::Boolean) — If the target should be removed once it is current and consistent.
#once=
def once=(value) -> ::Boolean
- value (::Boolean) — If the target should be removed once it is current and consistent.
- (::Boolean) — If the target should be removed once it is current and consistent.
#query
def query() -> ::Google::Cloud::Firestore::V1::Target::QueryTarget
- (::Google::Cloud::Firestore::V1::Target::QueryTarget) — A target specified by a query.
#query=
def query=(value) -> ::Google::Cloud::Firestore::V1::Target::QueryTarget
- value (::Google::Cloud::Firestore::V1::Target::QueryTarget) — A target specified by a query.
- (::Google::Cloud::Firestore::V1::Target::QueryTarget) — A target specified by a query.
#read_time
def read_time() -> ::Google::Protobuf::Timestamp
-
(::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
-
value (::Google::Protobuf::Timestamp) — Start listening after a specific
read_time
.The client must know the state of matching documents at this time.
-
(::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
-
(::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
-
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.
-
(::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
-
(::Integer) — The target ID that identifies the target on the stream. Must be a positive
number and non-zero.
If
target_id
is 0 (or unspecified), the server will assign an ID for this target and return that in aTargetChange::ADD
event. Once a target withtarget_id=0
is added, all subsequent targets must also havetarget_id=0
. If anAddTarget
request withtarget_id != 0
is sent to the server after a target withtarget_id=0
is added, the server will immediately send a response with aTargetChange::Remove
event.Note that if the client sends multiple
AddTarget
requests without an ID, the order of IDs returned inTargetChage.target_ids
are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one.If
target_id
is non-zero, there must not be an existing active target on this stream with the same ID.
#target_id=
def target_id=(value) -> ::Integer
-
value (::Integer) — The target ID that identifies the target on the stream. Must be a positive
number and non-zero.
If
target_id
is 0 (or unspecified), the server will assign an ID for this target and return that in aTargetChange::ADD
event. Once a target withtarget_id=0
is added, all subsequent targets must also havetarget_id=0
. If anAddTarget
request withtarget_id != 0
is sent to the server after a target withtarget_id=0
is added, the server will immediately send a response with aTargetChange::Remove
event.Note that if the client sends multiple
AddTarget
requests without an ID, the order of IDs returned inTargetChage.target_ids
are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one.If
target_id
is non-zero, there must not be an existing active target on this stream with the same ID.
-
(::Integer) — The target ID that identifies the target on the stream. Must be a positive
number and non-zero.
If
target_id
is 0 (or unspecified), the server will assign an ID for this target and return that in aTargetChange::ADD
event. Once a target withtarget_id=0
is added, all subsequent targets must also havetarget_id=0
. If anAddTarget
request withtarget_id != 0
is sent to the server after a target withtarget_id=0
is added, the server will immediately send a response with aTargetChange::Remove
event.Note that if the client sends multiple
AddTarget
requests without an ID, the order of IDs returned inTargetChage.target_ids
are undefined. Therefore, clients should provide a target ID instead of relying on the server to assign one.If
target_id
is non-zero, there must not be an existing active target on this stream with the same ID.