Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#database_id
def database_id() -> ::String
Returns
- (::String) — If not empty, the ID of the database to which the entities belong.
#database_id=
def database_id=(value) -> ::String
Parameter
- value (::String) — If not empty, the ID of the database to which the entities belong.
Returns
- (::String) — If not empty, the ID of the database to which the entities belong.
#namespace_id
def namespace_id() -> ::String
Returns
- (::String) — If not empty, the ID of the namespace to which the entities belong.
#namespace_id=
def namespace_id=(value) -> ::String
Parameter
- value (::String) — If not empty, the ID of the namespace to which the entities belong.
Returns
- (::String) — If not empty, the ID of the namespace to which the entities belong.
#project_id
def project_id() -> ::String
Returns
- (::String) — The ID of the project to which the entities belong.
#project_id=
def project_id=(value) -> ::String
Parameter
- value (::String) — The ID of the project to which the entities belong.
Returns
- (::String) — The ID of the project to which the entities belong.