Cloud Datastore V1 Client - Class Key (2.0.3)
Reference documentation and code samples for the Cloud Datastore V1 Client class Key.
A unique identifier for an entity.
If a key's partition ID or any of its path kinds or names arereserved/read-only, the key is reserved/read-only.A reserved/read-only key is forbidden in certain documented contexts.
Generated from protobuf messagegoogle.datastore.v1.Key
Namespace
Google \ Cloud \ Datastore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ partition_id | PartitionIdEntities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. |
↳ path | array<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 aroot entity, the second element identifies achild 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'sancestors. 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 |
getPartitionId
Entities are partitioned into subsets, currently identified by a projectID and namespace ID.
Queries are scoped to a single partition.
| Returns | |
|---|---|
| Type | Description |
PartitionId|null | |
hasPartitionId
clearPartitionId
setPartitionId
Entities are partitioned into subsets, currently identified by a projectID and namespace ID.
Queries are scoped to a single partition.
| Parameter | |
|---|---|
| Name | Description |
var | PartitionId |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPath
The entity path.
An entity path consists of one or more elements composed of a kind and astring or numerical identifier, which identify entities. The firstelement identifies aroot entity, the second element identifiesachild of the root entity, the third element identifies a child of thesecond entity, and so forth. The entities identified by all prefixes ofthe path are called the element'sancestors.An entity path is always fully complete:all of the entity's ancestorsare required to be in the path along with the entity identifier itself.The only exception is that in some documented cases, the identifier in thelast path element (for the entity) itself may be omitted. For example,the last path element of the key ofMutation.insert may have noidentifier.A path can never be empty, and a path can have at most 100 elements.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPath
The entity path.
An entity path consists of one or more elements composed of a kind and astring or numerical identifier, which identify entities. The firstelement identifies aroot entity, the second element identifiesachild of the root entity, the third element identifies a child of thesecond entity, and so forth. The entities identified by all prefixes ofthe path are called the element'sancestors.An entity path is always fully complete:all of the entity's ancestorsare required to be in the path along with the entity identifier itself.The only exception is that in some documented cases, the identifier in thelast path element (for the entity) itself may be omitted. For example,the last path element of the key ofMutation.insert may have noidentifier.A path can never be empty, and a path can have at most 100 elements.
| Parameter | |
|---|---|
| Name | Description |
var | array<Key\PathElement> |
| Returns | |
|---|---|
| Type | Description |
$this | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-24 UTC.