Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::Precondition (v1.3.0)

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

A precondition on a document, used for conditional operations.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#exists

def exists() -> ::Boolean
Returns
  • (::Boolean) — When set to true, the target document must exist. When set to false, the target document must not exist.

    Note: The following fields are mutually exclusive: exists, update_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#exists=

def exists=(value) -> ::Boolean
Parameter
  • value (::Boolean) — When set to true, the target document must exist. When set to false, the target document must not exist.

    Note: The following fields are mutually exclusive: exists, update_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Boolean) — When set to true, the target document must exist. When set to false, the target document must not exist.

    Note: The following fields are mutually exclusive: exists, update_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.

    Note: The following fields are mutually exclusive: update_time, exists. If a field in that set is populated, all other fields in the set will automatically be cleared.

#update_time=

def update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.

    Note: The following fields are mutually exclusive: update_time, exists. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Timestamp) — When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.

    Note: The following fields are mutually exclusive: update_time, exists. If a field in that set is populated, all other fields in the set will automatically be cleared.