public final class PartitionId extends GeneratedMessageV3 implements PartitionIdOrBuilder
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.
Protobuf type google.datastore.v1.PartitionId
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DATABASE_ID_FIELD_NUMBER
public static final int DATABASE_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAMESPACE_ID_FIELD_NUMBER
public static final int NAMESPACE_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static PartitionId getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PartitionId.Builder newBuilder()
newBuilder(PartitionId prototype)
public static PartitionId.Builder newBuilder(PartitionId prototype)
public static PartitionId parseDelimitedFrom(InputStream input)
public static PartitionId parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PartitionId parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PartitionId parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PartitionId parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PartitionId parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PartitionId parseFrom(CodedInputStream input)
public static PartitionId parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PartitionId parseFrom(InputStream input)
public static PartitionId parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PartitionId parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PartitionId parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PartitionId> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDatabaseId()
public String getDatabaseId()
If not empty, the ID of the database to which the entities
belong.
string database_id = 3;
| Returns |
|---|
| Type | Description |
String | The databaseId.
|
getDatabaseIdBytes()
public ByteString getDatabaseIdBytes()
If not empty, the ID of the database to which the entities
belong.
string database_id = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for databaseId.
|
getDefaultInstanceForType()
public PartitionId getDefaultInstanceForType()
getNamespaceId()
public String getNamespaceId()
If not empty, the ID of the namespace to which the entities belong.
string namespace_id = 4;
| Returns |
|---|
| Type | Description |
String | The namespaceId.
|
getNamespaceIdBytes()
public ByteString getNamespaceIdBytes()
If not empty, the ID of the namespace to which the entities belong.
string namespace_id = 4;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for namespaceId.
|
getParserForType()
public Parser<PartitionId> getParserForType()
Overrides
getProjectId()
public String getProjectId()
The ID of the project to which the entities belong.
string project_id = 2;
| Returns |
|---|
| Type | Description |
String | The projectId.
|
getProjectIdBytes()
public ByteString getProjectIdBytes()
The ID of the project to which the entities belong.
string project_id = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for projectId.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public PartitionId.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PartitionId.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public PartitionId.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
