Class: Google::Cloud::Firestore::V1::DocumentRemove

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/v1/write.rb

Overview

A Document has been removed from the view of the targets.

Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document.

Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected.

Instance Attribute Summary collapse

Instance Attribute Details

#document ⇒ ::String

Returns The resource name of the Document that has gone out of view.

Returns:

  • (::String) —

    The resource name of the Document that has gone out of view.



258
259
260
261
 
# File 'proto_docs/google/firestore/v1/write.rb', line 258

class DocumentRemove
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_time ⇒ ::Google::Protobuf::Timestamp

Returns The read timestamp at which the remove was observed.

Greater or equal to the commit_time of the change/delete/remove.

Returns:

  • (::Google::Protobuf::Timestamp) —

    The read timestamp at which the remove was observed.

    Greater or equal to the commit_time of the change/delete/remove.



258
259
260
261
 
# File 'proto_docs/google/firestore/v1/write.rb', line 258

class DocumentRemove
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#removed_target_ids ⇒ ::Array<::Integer>

Returns A set of target IDs for targets that previously matched this document.

Returns:

  • (::Array<::Integer>) —

    A set of target IDs for targets that previously matched this document.



258
259
260
261
 
# File 'proto_docs/google/firestore/v1/write.rb', line 258

class DocumentRemove
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end