public static final class Entity.Builder extends GeneratedMessageV3.Builder<Entity.Builder> implements EntityOrBuilder
A Datastore data object.
Must not exceed 1 MiB - 4 bytes.
Protobuf type google.datastore.v1.Entity
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Entity.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
| Returns |
| Type |
Description |
Entity |
|
buildPartial()
public Entity buildPartial()
| Returns |
| Type |
Description |
Entity |
|
clear()
public Entity.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public Entity.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearKey()
public Entity.Builder clearKey()
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public Entity.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearProperties()
public Entity.Builder clearProperties()
clone()
public Entity.Builder clone()
Overrides
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
|
getDefaultInstanceForType()
public Entity getDefaultInstanceForType()
| Returns |
| Type |
Description |
Entity |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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.
|
getKeyBuilder()
public Key.Builder getKeyBuilder()
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;
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;
getMutableProperties() (deprecated)
public Map<String,Value> getMutableProperties()
Use alternate mutation accessors instead.
getProperties() (deprecated)
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;
| Parameters |
| Name |
Description |
key |
String
|
defaultValue |
Value
|
| 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 |
|
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(Entity other)
public Entity.Builder mergeFrom(Entity other)
| Parameter |
| Name |
Description |
other |
Entity
|
public Entity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public Entity.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeKey(Key value)
public Entity.Builder mergeKey(Key value)
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;
| Parameter |
| Name |
Description |
value |
Key
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Entity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
putAllProperties(Map<String,Value> values)
public Entity.Builder putAllProperties(Map<String,Value> values)
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;
putProperties(String key, Value value)
public Entity.Builder putProperties(String key, Value value)
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;
putPropertiesBuilderIfAbsent(String key)
public Value.Builder putPropertiesBuilderIfAbsent(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
|
removeProperties(String key)
public Entity.Builder removeProperties(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
|
setField(Descriptors.FieldDescriptor field, Object value)
public Entity.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setKey(Key value)
public Entity.Builder setKey(Key value)
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;
| Parameter |
| Name |
Description |
value |
Key
|
setKey(Key.Builder builderForValue)
public Entity.Builder setKey(Key.Builder builderForValue)
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;
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Entity.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Entity.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
