Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::Entity (v1.4.1)

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

A Datastore data object.

Must not exceed 1 MiB - 4 bytes.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#key

def key() -> ::Google::Cloud::Datastore::V1::Key
Returns
  • (::Google::Cloud::Datastore::V1::Key) — The entity's key.

    An entity must have a key, unless otherwise documented (for example, an entity in Value.entity_value may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

#key=

def key=(value) -> ::Google::Cloud::Datastore::V1::Key
Parameter
  • value (::Google::Cloud::Datastore::V1::Key) — The entity's key.

    An entity must have a key, unless otherwise documented (for example, an entity in Value.entity_value may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

Returns
  • (::Google::Cloud::Datastore::V1::Key) — The entity's key.

    An entity must have a key, unless otherwise documented (for example, an entity in Value.entity_value may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.

#properties

def properties() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}) — The entity's properties. The map's keys are property names. A property name matching regex __.*__ is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

#properties=

def properties=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}) — The entity's properties. The map's keys are property names. A property name matching regex __.*__ is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}) — The entity's properties. The map's keys are property names. A property name matching regex __.*__ is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.