Reference documentation and code samples for the Cloud Datastore V1 Client class PathElement.
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.
Generated from protobuf message google.datastore.v1.Key.PathElement
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ kind |
string
The kind of the entity. A kind matching regex |
↳ id |
int|string
The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. |
↳ name |
string
The name of the entity. A name matching regex |
getKind
The kind of the entity.
A kind matching regex __.*__ is reserved/read-only.
A kind must not contain more than 1500 bytes when UTF-8 encoded.
Cannot be "".
Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
encoded as __bytes<X>__ where <X> is the base-64 encoding of the
bytes.
| Returns | |
|---|---|
| Type | Description |
string | |
setKind
The kind of the entity.
A kind matching regex __.*__ is reserved/read-only.
A kind must not contain more than 1500 bytes when UTF-8 encoded.
Cannot be "".
Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
encoded as __bytes<X>__ where <X> is the base-64 encoding of the
bytes.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
The auto-allocated ID of the entity.
Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasId
setId
The auto-allocated ID of the entity.
Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
The name of the entity.
A name matching regex __.*__ is reserved/read-only.
A name must not be more than 1500 bytes when UTF-8 encoded.
Cannot be "".
Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
encoded as __bytes<X>__ where <X> is the base-64 encoding of the
bytes.
| Returns | |
|---|---|
| Type | Description |
string | |
hasName
setName
The name of the entity.
A name matching regex __.*__ is reserved/read-only.
A name must not be more than 1500 bytes when UTF-8 encoded.
Cannot be "".
Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
encoded as __bytes<X>__ where <X> is the base-64 encoding of the
bytes.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIdType
| Returns | |
|---|---|
| Type | Description |
string | |