Class Key (3.8.1)

Stay organized with collections Save and categorize content based on your preferences.
Key(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A unique identifier for a Datastore 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.


Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
path Sequence[]
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*. A path can never be empty, and a path can have at most 100 elements.


builtins.object > proto.message.Message > Key



PathElement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: