Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::DocumentRemove (v0.10.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::DocumentRemove.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#document

def document() -> ::String
Returns
  • (::String) — The resource name of the Document that has gone out of view.

#document=

def document=(value) -> ::String
Parameter
  • value (::String) — 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.

#read_time

def read_time() -> ::Google::Protobuf::Timestamp
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.

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — 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.

#removed_target_ids

def removed_target_ids() -> ::Array<::Integer>
Returns
  • (::Array<::Integer>) — A set of target IDs for targets that previously matched this document.

#removed_target_ids=

def removed_target_ids=(value) -> ::Array<::Integer>
Parameter
  • value (::Array<::Integer>) — 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.