Class: Google::Apis::FirestoreV1::DocumentChange

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firestore_v1/classes.rb,
generated/google/apis/firestore_v1/representations.rb,
generated/google/apis/firestore_v1/representations.rb

Overview

A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, 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) ⇒ DocumentChange

Returns a new instance of DocumentChange



405
406
407
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 405

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

Instance Attribute Details

#document ⇒ Google::Apis::FirestoreV1::Document

A Firestore document. Must not exceed 1 MiB - 4 bytes. Corresponds to the JSON property document

Returns:



393
394
395
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 393

def document
  @document
end

#removed_target_ids ⇒ Array<Fixnum>

A set of target IDs for targets that no longer match this document. Corresponds to the JSON property removedTargetIds

Returns:

  • (Array<Fixnum>) 


398
399
400
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 398

def removed_target_ids
  @removed_target_ids
end

#target_ids ⇒ Array<Fixnum>

A set of target IDs of targets that match this document. Corresponds to the JSON property targetIds

Returns:

  • (Array<Fixnum>) 


403
404
405
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 403

def target_ids
  @target_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



410
411
412
413
414
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 410

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