Reference documentation and code samples for the Cloud Datastore V1 Client class Entity.
A Datastore data object.
Must not exceed 1 MiB - 4 bytes.
Generated from protobuf message google.datastore.v1.Entity
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ key |
Google\Cloud\Datastore\V1\Key
The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in |
↳ properties |
array|Google\Protobuf\Internal\MapField
The entity's properties. The map's keys are property names. A property name matching regex |
getKey
The entity's key.
An entity must have a key, unless otherwise documented (for example,
an entity in Value.entity_value may have no key).
An entity's kind is its key path's last element's kind,
or null if it has no key.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\Key|null | |
hasKey
clearKey
setKey
The entity's key.
An entity must have a key, unless otherwise documented (for example,
an entity in Value.entity_value may have no key).
An entity's kind is its key path's last element's kind,
or null if it has no key.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\Key
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProperties
The entity's properties.
The map's keys are property names.
A property name matching regex __.*__ is reserved.
A reserved property name is forbidden in certain documented contexts.
The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot
be empty.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setProperties
The entity's properties.
The map's keys are property names.
A property name matching regex __.*__ is reserved.
A reserved property name is forbidden in certain documented contexts.
The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot
be empty.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |