Class: Google::Apis::FirestoreV1::DocumentDelete

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 been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical 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) ⇒ DocumentDelete

Returns a new instance of DocumentDelete.


479
480
481
# File 'generated/google/apis/firestore_v1/classes.rb', line 479

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

Instance Attribute Details

#documentString

The resource name of the Document that was deleted. Corresponds to the JSON property document

Returns:

  • (String)

466
467
468
# File 'generated/google/apis/firestore_v1/classes.rb', line 466

def document
  @document
end

#read_timeString

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

Returns:

  • (String)

472
473
474
# File 'generated/google/apis/firestore_v1/classes.rb', line 472

def read_time
  @read_time
end

#removed_target_idsArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

477
478
479
# File 'generated/google/apis/firestore_v1/classes.rb', line 477

def removed_target_ids
  @removed_target_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


484
485
486
487
488
# File 'generated/google/apis/firestore_v1/classes.rb', line 484

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