Class PartitionId (0.14.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.events.cloud.datastore.v1.PartitionId

Static Fields

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

NAMESPACE_ID_FIELD_NUMBER

public static final int NAMESPACE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PartitionId getDefaultInstance()
Returns
TypeDescription
PartitionId

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PartitionId.Builder newBuilder()
Returns
TypeDescription
PartitionId.Builder

newBuilder(PartitionId prototype)

public static PartitionId.Builder newBuilder(PartitionId prototype)
Parameter
NameDescription
prototypePartitionId
Returns
TypeDescription
PartitionId.Builder

parseDelimitedFrom(InputStream input)

public static PartitionId parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PartitionId parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PartitionId parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PartitionId parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PartitionId parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PartitionId parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PartitionId parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PartitionId
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PartitionId> parser()
Returns
TypeDescription
Parser<PartitionId>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDatabaseId()

public String getDatabaseId()

If not empty, the ID of the database to which the entities belong.

string database_id = 3;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for databaseId.

getDefaultInstanceForType()

public PartitionId getDefaultInstanceForType()
Returns
TypeDescription
PartitionId

getNamespaceId()

public String getNamespaceId()

If not empty, the ID of the namespace to which the entities belong.

string namespace_id = 4;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for namespaceId.

getParserForType()

public Parser<PartitionId> getParserForType()
Returns
TypeDescription
Parser<PartitionId>
Overrides

getProjectId()

public String getProjectId()

The ID of the project to which the entities belong.

string project_id = 2;

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

The ID of the project to which the entities belong.

string project_id = 2;

Returns
TypeDescription
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PartitionId.Builder newBuilderForType()
Returns
TypeDescription
PartitionId.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PartitionId.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PartitionId.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PartitionId.Builder toBuilder()
Returns
TypeDescription
PartitionId.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException