Interface EntityOrBuilder (2.26.4)
Stay organized with collections
Save and categorize content based on your preferences.
publicinterface EntityOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsProperties(String key)
publicabstractbooleancontainsProperties(Stringkey) 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 |
boolean |
|
getKey()
publicabstractKeygetKey()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()
publicabstractKeyOrBuildergetKeyOrBuilder()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 |
KeyOrBuilder |
|
getProperties() (deprecated)
publicabstractMap<String,Value>getProperties()Use #getPropertiesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> |
|
getPropertiesCount()
publicabstractintgetPropertiesCount() 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()
publicabstractMap<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;
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> |
|
getPropertiesOrDefault(String key, Value defaultValue)
publicabstractValuegetPropertiesOrDefault(Stringkey,ValuedefaultValue) 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)
publicabstractValuegetPropertiesOrThrow(Stringkey) 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()
publicabstractbooleanhasKey()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. |