Class PartitionId.Builder (2.20.0)

Version 2.20.0

• 2.24.3 (latest)
• 2.24.1
• 2.23.0
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

public static final class PartitionId.Builder extends GeneratedMessageV3.Builder<PartitionId.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PartitionId.Builder

Implements

PartitionIdOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PartitionId.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
PartitionId.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public PartitionId build()

Returns
Type	Description
PartitionId

buildPartial()

public PartitionId buildPartial()

Returns
Type	Description
PartitionId

clear()

public PartitionId.Builder clear()

Returns
Type	Description
PartitionId.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDatabaseId()

public PartitionId.Builder clearDatabaseId()

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

string database_id = 3;

Returns
Type	Description
PartitionId.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PartitionId.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
PartitionId.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearNamespaceId()

public PartitionId.Builder clearNamespaceId()

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

string namespace_id = 4;

Returns
Type	Description
PartitionId.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PartitionId.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
PartitionId.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProjectId()

public PartitionId.Builder clearProjectId()

The ID of the project to which the entities belong.

string project_id = 2;

Returns
Type	Description
PartitionId.Builder	This builder for chaining.

clone()

public PartitionId.Builder clone()

Returns
Type	Description
PartitionId.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(PartitionId other)

public PartitionId.Builder mergeFrom(PartitionId other)

Parameter
Name	Description
other	PartitionId

Returns
Type	Description
PartitionId.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PartitionId.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PartitionId.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public PartitionId.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
PartitionId.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PartitionId.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
PartitionId.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setDatabaseId(String value)

public PartitionId.Builder setDatabaseId(String value)

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

string database_id = 3;

Parameter
Name	Description
value	String The databaseId to set.

Returns
Type	Description
PartitionId.Builder	This builder for chaining.

setDatabaseIdBytes(ByteString value)

public PartitionId.Builder setDatabaseIdBytes(ByteString value)

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

string database_id = 3;

Parameter
Name	Description
value	ByteString The bytes for databaseId to set.

Returns
Type	Description
PartitionId.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PartitionId.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
PartitionId.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setNamespaceId(String value)

public PartitionId.Builder setNamespaceId(String value)

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

string namespace_id = 4;

Parameter
Name	Description
value	String The namespaceId to set.

Returns
Type	Description
PartitionId.Builder	This builder for chaining.

setNamespaceIdBytes(ByteString value)

public PartitionId.Builder setNamespaceIdBytes(ByteString value)

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

string namespace_id = 4;

Parameter
Name	Description
value	ByteString The bytes for namespaceId to set.

Returns
Type	Description
PartitionId.Builder	This builder for chaining.

setProjectId(String value)

public PartitionId.Builder setProjectId(String value)

The ID of the project to which the entities belong.

string project_id = 2;

Parameter
Name	Description
value	String The projectId to set.

Returns
Type	Description
PartitionId.Builder	This builder for chaining.

setProjectIdBytes(ByteString value)

public PartitionId.Builder setProjectIdBytes(ByteString value)

The ID of the project to which the entities belong.

string project_id = 2;

Parameter
Name	Description
value	ByteString The bytes for projectId to set.

Returns
Type	Description
PartitionId.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PartitionId.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
PartitionId.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final PartitionId.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
PartitionId.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)