Package com.google.datastore.v1

Class Key

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.Key
All Implemented Interfaces:
KeyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Key extends com.google.protobuf.GeneratedMessageV3 implements KeyOrBuilder
 A unique identifier for an entity.
 If a key's partition ID or any of its path kinds or names are
 reserved/read-only, the key is reserved/read-only.
 A reserved/read-only key is forbidden in certain documented contexts.
Protobuf type google.datastore.v1.Key
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Key.Builder
    A unique identifier for an entity.
    static final class 
    Key.PathElement
    A (kind, ID/name) pair used to construct a key path.
    static interface 
    Key.PathElementOrBuilder
     

    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
    PARTITION_ID_FIELD_NUMBER
     
    static final int
    PATH_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)
     
    static Key
    getDefaultInstance()
     
    Key
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Key>
    getParserForType()
     
    PartitionId
    getPartitionId()
    Entities are partitioned into subsets, currently identified by a project ID and namespace ID.
    PartitionIdOrBuilder
    getPartitionIdOrBuilder()
    Entities are partitioned into subsets, currently identified by a project ID and namespace ID.
    Key.PathElement
    getPath(int index)
    The entity path.
    int
    getPathCount()
    The entity path.
    List<Key.PathElement>
    getPathList()
    The entity path.
    Key.PathElementOrBuilder
    getPathOrBuilder(int index)
    The entity path.
    List<? extends Key.PathElementOrBuilder>
    getPathOrBuilderList()
    The entity path.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasPartitionId()
    Entities are partitioned into subsets, currently identified by a project ID and namespace ID.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Key.Builder
    newBuilder()
     
    static Key.Builder
    newBuilder(Key prototype)
     
    Key.Builder
    newBuilderForType()
     
    protected Key.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Key
    parseDelimitedFrom(InputStream input)
     
    static Key
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Key
    parseFrom(byte[] data)
     
    static Key
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Key
    parseFrom(com.google.protobuf.ByteString data)
     
    static Key
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Key
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Key
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Key
    parseFrom(InputStream input)
     
    static Key
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Key
    parseFrom(ByteBuffer data)
     
    static Key
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Key>
    parser()
     
    Key.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, 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

  • 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

    • hasPartitionId

      public boolean hasPartitionId()
       Entities are partitioned into subsets, currently identified by a project
 ID and namespace ID.
 Queries are scoped to a single partition.
      .google.datastore.v1.PartitionId partition_id = 1;
      Specified by:
      hasPartitionId in interface KeyOrBuilder
      Returns:
      Whether the partitionId field is set.

    • getPartitionId

      public PartitionId getPartitionId()
       Entities are partitioned into subsets, currently identified by a project
 ID and namespace ID.
 Queries are scoped to a single partition.
      .google.datastore.v1.PartitionId partition_id = 1;
      Specified by:
      getPartitionId in interface KeyOrBuilder
      Returns:
      The partitionId.

    • getPartitionIdOrBuilder

      public PartitionIdOrBuilder getPartitionIdOrBuilder()
       Entities are partitioned into subsets, currently identified by a project
 ID and namespace ID.
 Queries are scoped to a single partition.
      .google.datastore.v1.PartitionId partition_id = 1;
      Specified by:
      getPartitionIdOrBuilder in interface KeyOrBuilder

    • getPathList

      public List<Key.PathElement> getPathList()
       The entity path.
 An entity path consists of one or more elements composed of a kind and a
 string or numerical identifier, which identify entities. The first
 element identifies a _root entity_, the second element identifies
 a _child_ of the root entity, the third element identifies a child of the
 second entity, and so forth. The entities identified by all prefixes of
 the path are called the element's _ancestors_.

 An entity path is always fully complete: *all* of the entity's ancestors
 are required to be in the path along with the entity identifier itself.
 The only exception is that in some documented cases, the identifier in the
 last path element (for the entity) itself may be omitted. For example,
 the last path element of the key of `Mutation.insert` may have no
 identifier.

 A path can never be empty, and a path can have at most 100 elements.
      repeated .google.datastore.v1.Key.PathElement path = 2;
      Specified by:
      getPathList in interface KeyOrBuilder

    • getPathOrBuilderList

      public List<? extends Key.PathElementOrBuilder> getPathOrBuilderList()
       The entity path.
 An entity path consists of one or more elements composed of a kind and a
 string or numerical identifier, which identify entities. The first
 element identifies a _root entity_, the second element identifies
 a _child_ of the root entity, the third element identifies a child of the
 second entity, and so forth. The entities identified by all prefixes of
 the path are called the element's _ancestors_.

 An entity path is always fully complete: *all* of the entity's ancestors
 are required to be in the path along with the entity identifier itself.
 The only exception is that in some documented cases, the identifier in the
 last path element (for the entity) itself may be omitted. For example,
 the last path element of the key of `Mutation.insert` may have no
 identifier.

 A path can never be empty, and a path can have at most 100 elements.
      repeated .google.datastore.v1.Key.PathElement path = 2;
      Specified by:
      getPathOrBuilderList in interface KeyOrBuilder

    • getPathCount

      public int getPathCount()
       The entity path.
 An entity path consists of one or more elements composed of a kind and a
 string or numerical identifier, which identify entities. The first
 element identifies a _root entity_, the second element identifies
 a _child_ of the root entity, the third element identifies a child of the
 second entity, and so forth. The entities identified by all prefixes of
 the path are called the element's _ancestors_.

 An entity path is always fully complete: *all* of the entity's ancestors
 are required to be in the path along with the entity identifier itself.
 The only exception is that in some documented cases, the identifier in the
 last path element (for the entity) itself may be omitted. For example,
 the last path element of the key of `Mutation.insert` may have no
 identifier.

 A path can never be empty, and a path can have at most 100 elements.
      repeated .google.datastore.v1.Key.PathElement path = 2;
      Specified by:
      getPathCount in interface KeyOrBuilder

    • getPath

      public Key.PathElement getPath(int index)
       The entity path.
 An entity path consists of one or more elements composed of a kind and a
 string or numerical identifier, which identify entities. The first
 element identifies a _root entity_, the second element identifies
 a _child_ of the root entity, the third element identifies a child of the
 second entity, and so forth. The entities identified by all prefixes of
 the path are called the element's _ancestors_.

 An entity path is always fully complete: *all* of the entity's ancestors
 are required to be in the path along with the entity identifier itself.
 The only exception is that in some documented cases, the identifier in the
 last path element (for the entity) itself may be omitted. For example,
 the last path element of the key of `Mutation.insert` may have no
 identifier.

 A path can never be empty, and a path can have at most 100 elements.
      repeated .google.datastore.v1.Key.PathElement path = 2;
      Specified by:
      getPath in interface KeyOrBuilder

    • getPathOrBuilder

      public Key.PathElementOrBuilder getPathOrBuilder(int index)
       The entity path.
 An entity path consists of one or more elements composed of a kind and a
 string or numerical identifier, which identify entities. The first
 element identifies a _root entity_, the second element identifies
 a _child_ of the root entity, the third element identifies a child of the
 second entity, and so forth. The entities identified by all prefixes of
 the path are called the element's _ancestors_.

 An entity path is always fully complete: *all* of the entity's ancestors
 are required to be in the path along with the entity identifier itself.
 The only exception is that in some documented cases, the identifier in the
 last path element (for the entity) itself may be omitted. For example,
 the last path element of the key of `Mutation.insert` may have no
 identifier.

 A path can never be empty, and a path can have at most 100 elements.
      repeated .google.datastore.v1.Key.PathElement path = 2;
      Specified by:
      getPathOrBuilder in interface KeyOrBuilder

    • 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 Key parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Key.Builder newBuilder()

    • newBuilder

      public static Key.Builder newBuilder(Key prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Key getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Key> 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 Key getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder