Cloud Datastore V1 Client - Class Key (1.23.0)

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 are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.

Generated from protobuf message google.datastore.v1.Key

Namespace

Google \ Cloud \ Datastore \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ partition_id 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 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.insert may have no identifier. A path can never be empty, and a path can have at most 100 elements.

getPartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID.

Queries are scoped to a single partition.

Returns
TypeDescription
Google\Cloud\Datastore\V1\PartitionId|null

hasPartitionId

clearPartitionId

setPartitionId

Entities are partitioned into subsets, currently identified by a project ID and namespace ID.

Queries are scoped to a single partition.

Parameter
NameDescription
var Google\Cloud\Datastore\V1\PartitionId
Returns
TypeDescription
$this

getPath

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.insert may have no identifier. A path can never be empty, and a path can have at most 100 elements.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPath

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.insert may have no identifier. A path can never be empty, and a path can have at most 100 elements.

Parameter
NameDescription
var array<Google\Cloud\Datastore\V1\Key\PathElement>
Returns
TypeDescription
$this