Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::Key.
A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#partition_id
def partition_id() -> ::Google::Cloud::Datastore::V1::PartitionId- (::Google::Cloud::Datastore::V1::PartitionId) — Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
#partition_id=
def partition_id=(value) -> ::Google::Cloud::Datastore::V1::PartitionId- value (::Google::Cloud::Datastore::V1::PartitionId) — Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- (::Google::Cloud::Datastore::V1::PartitionId) — Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
#path
def path() -> ::Array<::Google::Cloud::Datastore::V1::Key::PathElement>-
(::Array<::Google::Cloud::Datastore::V1::Key::PathElement>) — The entity path.
An entity path consists of one or more elements composed of a kind and a
string or numerical identifier, which identify entities. The first
element identifies a root entity, the second element identifies
a child of the root entity, the third element identifies a child of the
second entity, and so forth. The entities identified by all prefixes of
the path are called the element's ancestors.
An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of
Mutation.insertmay have no identifier.A path can never be empty, and a path can have at most 100 elements.
#path=
def path=(value) -> ::Array<::Google::Cloud::Datastore::V1::Key::PathElement>-
value (::Array<::Google::Cloud::Datastore::V1::Key::PathElement>) — The entity path.
An entity path consists of one or more elements composed of a kind and a
string or numerical identifier, which identify entities. The first
element identifies a root entity, the second element identifies
a child of the root entity, the third element identifies a child of the
second entity, and so forth. The entities identified by all prefixes of
the path are called the element's ancestors.
An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of
Mutation.insertmay have no identifier.A path can never be empty, and a path can have at most 100 elements.
-
(::Array<::Google::Cloud::Datastore::V1::Key::PathElement>) — The entity path.
An entity path consists of one or more elements composed of a kind and a
string or numerical identifier, which identify entities. The first
element identifies a root entity, the second element identifies
a child of the root entity, the third element identifies a child of the
second entity, and so forth. The entities identified by all prefixes of
the path are called the element's ancestors.
An entity path is always fully complete: all of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of
Mutation.insertmay have no identifier.A path can never be empty, and a path can have at most 100 elements.