Class PartitionId (2.19.1)

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

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()
Returns
Type Description
PartitionId

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PartitionId.Builder newBuilder()
Returns
Type Description
PartitionId.Builder

newBuilder(PartitionId prototype)

public static PartitionId.Builder newBuilder(PartitionId prototype)
Parameter
Name Description
prototype PartitionId
Returns
Type Description
PartitionId.Builder

parseDelimitedFrom(InputStream input)

public static PartitionId parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PartitionId
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionId
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PartitionId parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PartitionId
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionId
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PartitionId parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PartitionId
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionId
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PartitionId parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PartitionId
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionId
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PartitionId parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PartitionId
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionId
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PartitionId parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PartitionId
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PartitionId
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PartitionId> parser()
Returns
Type Description
Parser<PartitionId>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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()
Returns
Type Description
PartitionId

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()
Returns
Type Description
Parser<PartitionId>
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PartitionId.Builder newBuilderForType()
Returns
Type Description
PartitionId.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PartitionId.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PartitionId.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PartitionId.Builder toBuilder()
Returns
Type Description
PartitionId.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException