Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::Mutation (v1.0.0)

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::Mutation.

A mutation to apply to an entity.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#base_version

def base_version() -> ::Integer
Returns
  • (::Integer) — The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.

#base_version=

def base_version=(value) -> ::Integer
Parameter
  • value (::Integer) — The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.
Returns
  • (::Integer) — The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.

#delete

def delete() -> ::Google::Cloud::Datastore::V1::Key
Returns
  • (::Google::Cloud::Datastore::V1::Key) — The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.

#delete=

def delete=(value) -> ::Google::Cloud::Datastore::V1::Key
Parameter
  • value (::Google::Cloud::Datastore::V1::Key) — The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.
Returns
  • (::Google::Cloud::Datastore::V1::Key) — The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.

#insert

def insert() -> ::Google::Cloud::Datastore::V1::Entity
Returns

#insert=

def insert=(value) -> ::Google::Cloud::Datastore::V1::Entity
Parameter
Returns

#property_mask

def property_mask() -> ::Google::Cloud::Datastore::V1::PropertyMask
Returns
  • (::Google::Cloud::Datastore::V1::PropertyMask) — The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for __key__. This field is ignored for delete.

    If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted.

#property_mask=

def property_mask=(value) -> ::Google::Cloud::Datastore::V1::PropertyMask
Parameter
  • value (::Google::Cloud::Datastore::V1::PropertyMask) — The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for __key__. This field is ignored for delete.

    If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted.

Returns
  • (::Google::Cloud::Datastore::V1::PropertyMask) — The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for __key__. This field is ignored for delete.

    If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted.

#update

def update() -> ::Google::Cloud::Datastore::V1::Entity
Returns

#update=

def update=(value) -> ::Google::Cloud::Datastore::V1::Entity
Parameter
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts.

#update_time=

def update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts.
Returns
  • (::Google::Protobuf::Timestamp) — The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts.

#upsert

def upsert() -> ::Google::Cloud::Datastore::V1::Entity
Returns

#upsert=

def upsert=(value) -> ::Google::Cloud::Datastore::V1::Entity
Parameter
Returns