Reference documentation and code samples for the Cloud Datastore V1 Client class PartitionId.
A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.
A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions:
- May be
"". - Must be valid UTF-8 bytes.
- Must have values that match regex
[A-Za-z\d\.\-_]{1,100}If the value of any dimension matches regex__.*__, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.
Generated from protobuf message google.datastore.v1.PartitionId
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project_id |
string
The ID of the project to which the entities belong. |
↳ database_id |
string
If not empty, the ID of the database to which the entities belong. |
↳ namespace_id |
string
If not empty, the ID of the namespace to which the entities belong. |
getProjectId
The ID of the project to which the entities belong.
Generated from protobuf field string project_id = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setProjectId
The ID of the project to which the entities belong.
Generated from protobuf field string project_id = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDatabaseId
If not empty, the ID of the database to which the entities belong.
Generated from protobuf field string database_id = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setDatabaseId
If not empty, the ID of the database to which the entities belong.
Generated from protobuf field string database_id = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNamespaceId
If not empty, the ID of the namespace to which the entities belong.
Generated from protobuf field string namespace_id = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
setNamespaceId
If not empty, the ID of the namespace to which the entities belong.
Generated from protobuf field string namespace_id = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |