Class: Google::Apis::FirestoreV1::Precondition

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 precondition on a document, used for conditional operations.

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) ⇒ Precondition

Returns a new instance of Precondition



1829
1830
1831
# File 'generated/google/apis/firestore_v1/classes.rb', line 1829

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

Instance Attribute Details

#existsBoolean Also known as: exists?

When set to true, the target document must exist. When set to false, the target document must not exist. Corresponds to the JSON property exists

Returns:

  • (Boolean)


1820
1821
1822
# File 'generated/google/apis/firestore_v1/classes.rb', line 1820

def exists
  @exists
end

#update_timeString

When set, the target document must exist and have been last updated at that time. Corresponds to the JSON property updateTime

Returns:

  • (String)


1827
1828
1829
# File 'generated/google/apis/firestore_v1/classes.rb', line 1827

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1834
1835
1836
1837
# File 'generated/google/apis/firestore_v1/classes.rb', line 1834

def update!(**args)
  @exists = args[:exists] if args.key?(:exists)
  @update_time = args[:update_time] if args.key?(:update_time)
end