Package com.google.datastore.v1

Class Key.PathElement

  • All Implemented Interfaces:
    Key.PathElementOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Key
    public static final class Key.PathElement
extends com.google.protobuf.GeneratedMessageV3
implements Key.PathElementOrBuilder
     A (kind, ID/name) pair used to construct a key path.

 If either name or ID is set, the element is complete.
 If neither is set, the element is incomplete.
    Protobuf type google.datastore.v1.Key.PathElement
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Key.PathElement.Builder
      A (kind, ID/name) pair used to construct a key path.
      static class  Key.PathElement.IdTypeCase  

      • 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 int ID_FIELD_NUMBER  
      static int KIND_FIELD_NUMBER  
      static int NAME_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 Detail

      • 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

      • getKind

        public String getKind()
         The kind of the entity.

 A kind matching regex `__.*__` is reserved/read-only.
 A kind must not contain more than 1500 bytes when UTF-8 encoded.
 Cannot be `""`.

 Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
 encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the
 bytes.
        string kind = 1;
        Specified by:
        getKind in interface Key.PathElementOrBuilder
        Returns:
        The kind.

      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         The kind of the entity.

 A kind matching regex `__.*__` is reserved/read-only.
 A kind must not contain more than 1500 bytes when UTF-8 encoded.
 Cannot be `""`.

 Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
 encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the
 bytes.
        string kind = 1;
        Specified by:
        getKindBytes in interface Key.PathElementOrBuilder
        Returns:
        The bytes for kind.

      • hasId

        public boolean hasId()
         The auto-allocated ID of the entity.

 Never equal to zero. Values less than zero are discouraged and may not
 be supported in the future.
        int64 id = 2;
        Specified by:
        hasId in interface Key.PathElementOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         The auto-allocated ID of the entity.

 Never equal to zero. Values less than zero are discouraged and may not
 be supported in the future.
        int64 id = 2;
        Specified by:
        getId in interface Key.PathElementOrBuilder
        Returns:
        The id.

      • hasName

        public boolean hasName()
         The name of the entity.

 A name matching regex `__.*__` is reserved/read-only.
 A name must not be more than 1500 bytes when UTF-8 encoded.
 Cannot be `""`.

 Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
 encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the
 bytes.
        string name = 3;
        Specified by:
        hasName in interface Key.PathElementOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public String getName()
         The name of the entity.

 A name matching regex `__.*__` is reserved/read-only.
 A name must not be more than 1500 bytes when UTF-8 encoded.
 Cannot be `""`.

 Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
 encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the
 bytes.
        string name = 3;
        Specified by:
        getName in interface Key.PathElementOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the entity.

 A name matching regex `__.*__` is reserved/read-only.
 A name must not be more than 1500 bytes when UTF-8 encoded.
 Cannot be `""`.

 Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
 encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the
 bytes.
        string name = 3;
        Specified by:
        getNameBytes in interface Key.PathElementOrBuilder
        Returns:
        The bytes for name.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Key.PathElement 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.PathElement parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

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

      • getParserForType

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