public final class Entity extends GeneratedMessageV3 implements EntityOrBuilder
A Datastore data object.
An entity is limited to 1 megabyte when stored. That roughly
corresponds to a limit of 1 megabyte for the serialized form of this
message.
Protobuf type google.datastore.v1.Entity
Static Fields
KEY_FIELD_NUMBER
public static final int KEY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROPERTIES_FIELD_NUMBER
public static final int PROPERTIES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Entity getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Entity.Builder newBuilder()
newBuilder(Entity prototype)
public static Entity.Builder newBuilder(Entity prototype)
| Parameter |
|---|
| Name | Description |
prototype | Entity
|
public static Entity parseDelimitedFrom(InputStream input)
public static Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Entity parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Entity parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Entity parseFrom(CodedInputStream input)
public static Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Entity parseFrom(InputStream input)
public static Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Entity parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Entity> parser()
Methods
containsProperties(String key)
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;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public Entity getDefaultInstanceForType()
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;
| Returns |
|---|
| Type | Description |
Key | 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;
getParserForType()
public Parser<Entity> getParserForType()
Overrides
getProperties()
public Map<String,Value> getProperties()
getPropertiesCount()
public int getPropertiesCount()
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;
| Returns |
|---|
| Type | Description |
int | |
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;
getPropertiesOrDefault(String key, Value defaultValue)
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;
| Returns |
|---|
| Type | Description |
Value | |
getPropertiesOrThrow(String key)
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;
| Parameter |
|---|
| Name | Description |
key | String
|
| Returns |
|---|
| Type | Description |
Value | |
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the key field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Entity.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Entity.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
