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.
Attributes
Name
Description
partition_id
google.cloud.dlp_v2.types.PartitionId Entities are partitioned into subsets,
currently identified by a project ID and
namespace ID. Queries are scoped to a single
partition.
path
MutableSequence[google.cloud.dlp_v2.types.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*.
A path can never be empty, and a path can have at most 100
elements.
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 hasoneof_ 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Class Key (3.31.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.31.0 (latest)](/python/docs/reference/dlp/latest/google.cloud.dlp_v2.types.Key)\n- [3.30.0](/python/docs/reference/dlp/3.30.0/google.cloud.dlp_v2.types.Key)\n- [3.29.0](/python/docs/reference/dlp/3.29.0/google.cloud.dlp_v2.types.Key)\n- [3.28.0](/python/docs/reference/dlp/3.28.0/google.cloud.dlp_v2.types.Key)\n- [3.27.0](/python/docs/reference/dlp/3.27.0/google.cloud.dlp_v2.types.Key)\n- [3.26.0](/python/docs/reference/dlp/3.26.0/google.cloud.dlp_v2.types.Key)\n- [3.25.1](/python/docs/reference/dlp/3.25.1/google.cloud.dlp_v2.types.Key)\n- [3.24.0](/python/docs/reference/dlp/3.24.0/google.cloud.dlp_v2.types.Key)\n- [3.23.0](/python/docs/reference/dlp/3.23.0/google.cloud.dlp_v2.types.Key)\n- [3.22.0](/python/docs/reference/dlp/3.22.0/google.cloud.dlp_v2.types.Key)\n- [3.20.0](/python/docs/reference/dlp/3.20.0/google.cloud.dlp_v2.types.Key)\n- [3.19.0](/python/docs/reference/dlp/3.19.0/google.cloud.dlp_v2.types.Key)\n- [3.18.1](/python/docs/reference/dlp/3.18.1/google.cloud.dlp_v2.types.Key)\n- [3.17.0](/python/docs/reference/dlp/3.17.0/google.cloud.dlp_v2.types.Key)\n- [3.16.0](/python/docs/reference/dlp/3.16.0/google.cloud.dlp_v2.types.Key)\n- [3.15.3](/python/docs/reference/dlp/3.15.3/google.cloud.dlp_v2.types.Key)\n- [3.14.0](/python/docs/reference/dlp/3.14.0/google.cloud.dlp_v2.types.Key)\n- [3.13.0](/python/docs/reference/dlp/3.13.0/google.cloud.dlp_v2.types.Key)\n- [3.12.3](/python/docs/reference/dlp/3.12.3/google.cloud.dlp_v2.types.Key)\n- [3.11.1](/python/docs/reference/dlp/3.11.1/google.cloud.dlp_v2.types.Key)\n- [3.10.1](/python/docs/reference/dlp/3.10.1/google.cloud.dlp_v2.types.Key)\n- [3.9.2](/python/docs/reference/dlp/3.9.2/google.cloud.dlp_v2.types.Key)\n- [3.8.1](/python/docs/reference/dlp/3.8.1/google.cloud.dlp_v2.types.Key)\n- [3.7.1](/python/docs/reference/dlp/3.7.1/google.cloud.dlp_v2.types.Key)\n- [3.6.2](/python/docs/reference/dlp/3.6.2/google.cloud.dlp_v2.types.Key)\n- [3.5.0](/python/docs/reference/dlp/3.5.0/google.cloud.dlp_v2.types.Key)\n- [3.4.0](/python/docs/reference/dlp/3.4.0/google.cloud.dlp_v2.types.Key)\n- [3.3.1](/python/docs/reference/dlp/3.3.1/google.cloud.dlp_v2.types.Key)\n- [3.2.4](/python/docs/reference/dlp/3.2.4/google.cloud.dlp_v2.types.Key)\n- [3.1.1](/python/docs/reference/dlp/3.1.1/google.cloud.dlp_v2.types.Key)\n- [3.0.1](/python/docs/reference/dlp/3.0.1/google.cloud.dlp_v2.types.Key)\n- [2.0.2](/python/docs/reference/dlp/2.0.2/google.cloud.dlp_v2.types.Key)\n- [1.0.2](/python/docs/reference/dlp/1.0.2/google.cloud.dlp_v2.types.Key)\n- [0.15.2](/python/docs/reference/dlp/0.15.2/google.cloud.dlp_v2.types.Key)\n- [0.14.0](/python/docs/reference/dlp/0.14.0/google.cloud.dlp_v2.types.Key)\n- [0.13.0](/python/docs/reference/dlp/0.13.0/google.cloud.dlp_v2.types.Key)\n- [0.12.1](/python/docs/reference/dlp/0.12.1/google.cloud.dlp_v2.types.Key) \n\n Key(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented\ncontexts.\n\nClasses\n-------\n\n### PathElement\n\n PathElement(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nA (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete. If neither\nis set, the element is incomplete.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e"]]
