Package com.google.datastore.v1

Class PartitionId

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.PartitionId
All Implemented Interfaces:
PartitionIdOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class PartitionId extends com.google.protobuf.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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PartitionId.Builder
    A partition ID identifies a grouping of entities.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DATABASE_ID_FIELD_NUMBER
     
    static final int
    NAMESPACE_ID_FIELD_NUMBER
     
    static final int
    PROJECT_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getDatabaseId()
    If not empty, the ID of the database to which the entities belong.
    com.google.protobuf.ByteString
    getDatabaseIdBytes()
    If not empty, the ID of the database to which the entities belong.
    static PartitionId
    getDefaultInstance()
     
    PartitionId
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getNamespaceId()
    If not empty, the ID of the namespace to which the entities belong.
    com.google.protobuf.ByteString
    getNamespaceIdBytes()
    If not empty, the ID of the namespace to which the entities belong.
    com.google.protobuf.Parser<PartitionId>
    getParserForType()
     
    String
    getProjectId()
    The ID of the project to which the entities belong.
    com.google.protobuf.ByteString
    getProjectIdBytes()
    The ID of the project to which the entities belong.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PartitionId.Builder
    newBuilder()
     
    static PartitionId.Builder
    newBuilder(PartitionId prototype)
     
    PartitionId.Builder
    newBuilderForType()
     
    protected PartitionId.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static PartitionId
    parseDelimitedFrom(InputStream input)
     
    static PartitionId
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionId
    parseFrom(byte[] data)
     
    static PartitionId
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionId
    parseFrom(com.google.protobuf.ByteString data)
     
    static PartitionId
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionId
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PartitionId
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionId
    parseFrom(InputStream input)
     
    static PartitionId
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionId
    parseFrom(ByteBuffer data)
     
    static PartitionId
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PartitionId>
    parser()
     
    PartitionId.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • PROJECT_ID_FIELD_NUMBER

      public static final int PROJECT_ID_FIELD_NUMBER
      See Also:

    • DATABASE_ID_FIELD_NUMBER

      public static final int DATABASE_ID_FIELD_NUMBER
      See Also:

    • NAMESPACE_ID_FIELD_NUMBER

      public static final int NAMESPACE_ID_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getProjectId

      public String getProjectId()
       The ID of the project to which the entities belong.
      string project_id = 2;
      Specified by:
      getProjectId in interface PartitionIdOrBuilder
      Returns:
      The projectId.

    • getProjectIdBytes

      public com.google.protobuf.ByteString getProjectIdBytes()
       The ID of the project to which the entities belong.
      string project_id = 2;
      Specified by:
      getProjectIdBytes in interface PartitionIdOrBuilder
      Returns:
      The bytes for projectId.

    • getDatabaseId

      public String getDatabaseId()
       If not empty, the ID of the database to which the entities
 belong.
      string database_id = 3;
      Specified by:
      getDatabaseId in interface PartitionIdOrBuilder
      Returns:
      The databaseId.

    • getDatabaseIdBytes

      public com.google.protobuf.ByteString getDatabaseIdBytes()
       If not empty, the ID of the database to which the entities
 belong.
      string database_id = 3;
      Specified by:
      getDatabaseIdBytes in interface PartitionIdOrBuilder
      Returns:
      The bytes for databaseId.

    • getNamespaceId

      public String getNamespaceId()
       If not empty, the ID of the namespace to which the entities belong.
      string namespace_id = 4;
      Specified by:
      getNamespaceId in interface PartitionIdOrBuilder
      Returns:
      The namespaceId.

    • getNamespaceIdBytes

      public com.google.protobuf.ByteString getNamespaceIdBytes()
       If not empty, the ID of the namespace to which the entities belong.
      string namespace_id = 4;
      Specified by:
      getNamespaceIdBytes in interface PartitionIdOrBuilder
      Returns:
      The bytes for namespaceId.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PartitionId parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionId parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionId parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionId parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionId parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionId parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionId parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PartitionId parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PartitionId parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PartitionId parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PartitionId parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PartitionId parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PartitionId.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PartitionId.Builder newBuilder()

    • newBuilder

      public static PartitionId.Builder newBuilder(PartitionId prototype)

    • toBuilder

      public PartitionId.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PartitionId.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static PartitionId getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PartitionId> parser()

    • getParserForType

      public com.google.protobuf.Parser<PartitionId> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public PartitionId getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder