Class: Google::Apis::FirestoreV1beta1::DocumentRemove

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firestore_v1beta1/classes.rb,
generated/google/apis/firestore_v1beta1/representations.rb,
generated/google/apis/firestore_v1beta1/representations.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 Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DocumentRemove

Returns a new instance of DocumentRemove.


538
539
540
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 538

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#documentString

The resource name of the Document that has gone out of view. Corresponds to the JSON property document

Returns:

  • (String)

525
526
527
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 525

def document
  @document
end

#read_timeString

The read timestamp at which the remove was observed. Greater or equal to the commit_time of the change/delete/remove. Corresponds to the JSON property readTime

Returns:

  • (String)

531
532
533
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 531

def read_time
  @read_time
end

#removed_target_idsArray<Fixnum>

A set of target IDs for targets that previously matched this document. Corresponds to the JSON property removedTargetIds

Returns:

  • (Array<Fixnum>)

536
537
538
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 536

def removed_target_ids
  @removed_target_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


543
544
545
546
547
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 543

def update!(**args)
  @document = args[:document] if args.key?(:document)
  @read_time = args[:read_time] if args.key?(:read_time)
  @removed_target_ids = args[:removed_target_ids] if args.key?(:removed_target_ids)
end