Package com.google.datastore.v1

Class Entity

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.Entity
All Implemented Interfaces:
EntityOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Entity extends com.google.protobuf.GeneratedMessageV3 implements EntityOrBuilder
 A Datastore data object.

 Must not exceed 1 MiB - 4 bytes.
Protobuf type google.datastore.v1.Entity
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Entity.Builder
    A Datastore data object.

    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
    KEY_FIELD_NUMBER
     
    static final int
    PROPERTIES_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
    containsProperties(String key)
    The entity's properties.
    boolean
    equals(Object obj)
     
    static Entity
    getDefaultInstance()
     
    Entity
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Key
    getKey()
    The entity's key.
    KeyOrBuilder
    getKeyOrBuilder()
    The entity's key.
    com.google.protobuf.Parser<Entity>
    getParserForType()
     
    Map<String,Value>
    getProperties()
    Deprecated.
    int
    getPropertiesCount()
    The entity's properties.
    Map<String,Value>
    getPropertiesMap()
    The entity's properties.
    Value
    getPropertiesOrDefault(String key, Value defaultValue)
    The entity's properties.
    Value
    getPropertiesOrThrow(String key)
    The entity's properties.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasKey()
    The entity's key.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapField
    internalGetMapField(int number)
     
    final boolean
    isInitialized()
     
    static Entity.Builder
    newBuilder()
     
    static Entity.Builder
    newBuilder(Entity prototype)
     
    Entity.Builder
    newBuilderForType()
     
    protected Entity.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Entity
    parseDelimitedFrom(InputStream input)
     
    static Entity
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Entity
    parseFrom(byte[] data)
     
    static Entity
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Entity
    parseFrom(com.google.protobuf.ByteString data)
     
    static Entity
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Entity
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Entity
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Entity
    parseFrom(InputStream input)
     
    static Entity
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Entity
    parseFrom(ByteBuffer data)
     
    static Entity
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Entity>
    parser()
     
    Entity.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, 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()

    • internalGetMapField

      protected com.google.protobuf.MapField internalGetMapField(int number)
      Overrides:
      internalGetMapField in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

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

    • hasKey

      public boolean hasKey()
       The entity's key.

 An entity must have a key, unless otherwise documented (for example,
 an entity in `Value.entity_value` may have no key).
 An entity's kind is its key path's last element's kind,
 or null if it has no key.
      .google.datastore.v1.Key key = 1;
      Specified by:
      hasKey in interface EntityOrBuilder
      Returns:
      Whether the key field is set.

    • getKey

      public Key getKey()
       The entity's key.

 An entity must have a key, unless otherwise documented (for example,
 an entity in `Value.entity_value` may have no key).
 An entity's kind is its key path's last element's kind,
 or null if it has no key.
      .google.datastore.v1.Key key = 1;
      Specified by:
      getKey in interface EntityOrBuilder
      Returns:
      The key.

    • getKeyOrBuilder

      public KeyOrBuilder getKeyOrBuilder()
       The entity's key.

 An entity must have a key, unless otherwise documented (for example,
 an entity in `Value.entity_value` may have no key).
 An entity's kind is its key path's last element's kind,
 or null if it has no key.
      .google.datastore.v1.Key key = 1;
      Specified by:
      getKeyOrBuilder in interface EntityOrBuilder

    • getPropertiesCount

      public int getPropertiesCount()
      Description copied from interface: EntityOrBuilder
       The entity's properties.
 The map's keys are property names.
 A property name matching regex `__.*__` is reserved.
 A reserved property name is forbidden in certain documented contexts.
 The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot
 be empty.
      map<string, .google.datastore.v1.Value> properties = 3;
      Specified by:
      getPropertiesCount in interface EntityOrBuilder

    • containsProperties

      public boolean containsProperties(String key)
       The entity's properties.
 The map's keys are property names.
 A property name matching regex `__.*__` is reserved.
 A reserved property name is forbidden in certain documented contexts.
 The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot
 be empty.
      map<string, .google.datastore.v1.Value> properties = 3;
      Specified by:
      containsProperties in interface EntityOrBuilder

    • getProperties

      @Deprecated public Map<String,Value> getProperties()
      Deprecated.
      Use getPropertiesMap() instead.
      Specified by:
      getProperties in interface EntityOrBuilder

    • getPropertiesMap

      public Map<String,Value> getPropertiesMap()
       The entity's properties.
 The map's keys are property names.
 A property name matching regex `__.*__` is reserved.
 A reserved property name is forbidden in certain documented contexts.
 The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot
 be empty.
      map<string, .google.datastore.v1.Value> properties = 3;
      Specified by:
      getPropertiesMap in interface EntityOrBuilder

    • getPropertiesOrDefault

      public Value getPropertiesOrDefault(String key, Value defaultValue)
       The entity's properties.
 The map's keys are property names.
 A property name matching regex `__.*__` is reserved.
 A reserved property name is forbidden in certain documented contexts.
 The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot
 be empty.
      map<string, .google.datastore.v1.Value> properties = 3;
      Specified by:
      getPropertiesOrDefault in interface EntityOrBuilder

    • getPropertiesOrThrow

      public Value getPropertiesOrThrow(String key)
       The entity's properties.
 The map's keys are property names.
 A property name matching regex `__.*__` is reserved.
 A reserved property name is forbidden in certain documented contexts.
 The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot
 be empty.
      map<string, .google.datastore.v1.Value> properties = 3;
      Specified by:
      getPropertiesOrThrow in interface EntityOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Entity.Builder newBuilder()

    • newBuilder

      public static Entity.Builder newBuilder(Entity prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Entity getDefaultInstance()

    • parser

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

    • getParserForType

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