package com.google.appengine.entity

Get desktop application:
View/edit binary Protocol Buffers messages

Used as request type in: datastore_v3.DatastoreService.CreateIndex, datastore_v3.DatastoreService.DeleteIndex, datastore_v3.DatastoreService.UpdateIndex

Used as field type in: datastore_v3.CompositeIndices, datastore_v3.PutRequest, datastore_v3.Query, net.notdot.bdbdatastore.IndexList

• required string app_id = 1

  The app that owns this composite index.

• required int64 id = 2

  The index's ID. Used in CompositeProperty.

• required Index definition = 3

  The index definition, including the entity type and properties.

• required CompositeIndex.State state = 4

WRITE_ONLY indices have been created, but are not yet fully populated. Composite properties for them must be populated when entities are Put, but they may not yet be used to execute queries. READ_WRITE indices are fully populated. They may be used to execute queries. Like WRITE_ONLY, composite properties for them must be populated on Puts. DELETED indices are marked for eventual deletion from the CompositeIndices table. They should be disregarded for both queries and Puts. ERROR indices encountered an error while being built or deleted. They should be disregarded for both queries and Puts. The allowed state changes are: WRITE_ONLY => READ_WRITE WRITE_ONLY => DELETED WRITE_ONLY => ERROR READ_WRITE => DELETED ERROR => DELETED DELETED => ERROR

Used in: CompositeIndex

• WRITE_ONLY = 1

• READ_WRITE = 2

• DELETED = 3

• ERROR = 4

Composite properties for composite indexes. These are populated by the datastore implementation based on the entity's properties and the application-defined custom indexes.

• required int64 index_id = 1

  The ID of the associated composite index.

• repeated bytes value = 2

  The first value element is the ancestor, if the index calls for it, as a byte-encoded Path. The rest are the properties in the index, in order, as byte-encoded PropertyValues. A byte-encoding format is used. The descending byte-encoding format is used if the property should be sorted in descending order. As with PropertyValue, embedded Path and PropertyValue fields aren't used because we can't index nested PBs.

Used in: datastore_v3.GetResponse.Entity, datastore_v3.PutRequest, datastore_v3.QueryResult, datastore_v3.Schema, net.notdot.bdbdatastore.EntityData

• required Reference key = 13

  This entity's primary key. Contains app name and path.

• required Path entity_group = 16

  This entity's group. By default, this is the top-level entity's path.

• optional User owner = 17

  The user who was logged in when this entity was created. This is currently unused.

• optional EntityProto.Kind kind = 4

• optional bytes kind_uri = 5

  If requested, raw URIs may be used to define a semantic kind for an entity. This is less efficient, but allows anything to be expressed, and popular URIs may be converted to enum Kind values later.

• repeated Property property = 14

  Properties that should be indexed by value go in the property field. Properties that shouldn't, like blobs and long text fields (e.g. XML), go in raw_property.

• repeated Property raw_property = 15

Kinds represent particular semantic kinds of entities. Entity kinds are akin to GDNamespace kinds, which are richer than a single property, and represent a set of properties. Essentially, this is the direct analogue of Meaning, but on a whole-entity level.

Used in: EntityProto

• GD_CONTACT = 1

  GDNamespace kinds:

  a contact, such as a person, venue, organization

• GD_EVENT = 2

  a calendar event

• GD_MESSAGE = 3

  such as an email, a discussion group posting

Used in: datastore_v3.QueryExplanation, CompositeIndex

• required bytes entity_type = 1

  The type of entity being indexed.

• required bool ancestor = 5

  If true, each of the entity's ancestors will be included. Each direct ancestor is indexed separately in its own composite property. For example, an entity with the path /Blog,1/Post,2/Comment,3 would have separate composite properties for /Blog,1 and /Blog,1/Post,2.

• repeated group com.google.appengine.entity.Index.Property = 2

A sequence of property names and directions.

Used in: Index

• required bytes name = 3

• optional Property.Direction direction = 4

Used in: Property

• ASCENDING = 1

• DESCENDING = 2

A path; also used as an Entity Group key. This is an ordered list of (type, id or name) tuples. Each element should have either an id or a name, but not both. Clarification: "so, yeah, it's a little tricky. that comment correctly describes all Path PBs that refer to *complete* keys. for new entities that haven't been inserted yet, and don't use name, the datastore will allocate them an id when they're inserted. given that, their keys are incomplete until they're inserted. so, when the runtime sends them to the datastore in a PutRequest, they won't have an id yet, so the last path element will only have type, not id or name."

Used in: EntityProto, Reference, net.notdot.bdbdatastore.CompositeIndexKey, net.notdot.bdbdatastore.EntityKey

• repeated group com.google.appengine.entity.Path.Element = 1

Used in: Path

• required bytes type = 2

• optional int64 id = 3

  In paths that have been persisted, one and only one of the following should be set.

• optional bytes name = 4

Used in: datastore_v3.Query.Filter, EntityProto

• optional Property.Meaning meaning = 1

  Meanings are optional. If they are not provided, some amount of meaning may already be implied by the underlying storage type, such as User or Reference.

• optional bytes meaning_uri = 2

  If requested, raw URIs may be used to define semantic meaning for a property. This is less efficient, but allows anything to be expressed, and popular URIs may be converted to enum Meaning values later.

• required bytes name = 3

  The name of this property.

• required PropertyValue value = 5

  The property value.

• optional bool multiple = 4

  Whether this property is multiply valued or not. (If true, it may have multiple values now, or it may be *intended* to have multiple values eventually, even if it has just one now.) This is currently used as sugar for the native language datastore APIs, so they know whether to return a property value as a single value or a list.

Meanings usually, but not always, have a functional relationship to storage type. Some don't, however: an ATOM_AUTHOR might be a User or a string, depending on what was stored.

Used in: Property

• BLOB = 14

  NOTE: using meaning to indicate blobs and text is a double-edged sword. if future semantic meanings are also text or blobs, they'll need to be special-cased in code.

  raw binary data, of any length

• TEXT = 15

  a UTF-8 encoded string, of any length

• ATOM_CATEGORY = 1

  from the http://www.w3.org/2005/Atom namespace. see http://www.atomenabled.org/developers/syndication/

  a tag

• ATOM_LINK = 2

  a URI

• ATOM_TITLE = 3

  a human readable title

• ATOM_CONTENT = 4

  the main "content" of the entity

• ATOM_SUMMARY = 5

  a human readable short summary

• ATOM_AUTHOR = 6

  the author, a person

• GD_WHEN = 7

  from the http://schemas.google.com/g/2005 namespace. see http://code.google.com/apis/gdata/common-elements.html many elements are missing, notably gd:entryLink, gd:feedLink, gd:originalEvent, gd:recurrence*, gd:where, and gd:who. use REFERENCE, ATOM_LINK, GD_POSTALADDRESS, GD_GEOPT, and the Contact entity instead.

  timestamp, as int64 microseconds since the epoch

• GD_EMAIL = 8

  RFC 2822 email address

• GEORSS_POINT = 9

  "lat,long"

• GD_IM = 10

  IANA-style URI, e.g. xmpp:heaven@gmail.com

• GD_PHONENUMBER = 11

  or aim:goim?screenname=bl4ize

  human-readable phone number, any format

• GD_POSTALADDRESS = 12

  human-readable postal address. leading and

• GD_RATING = 13

  trailing whitespace are stripped; embedded newlines and whitespace are significant.

  an integer rating in [0, 100].

The PropertyValue PB represents a property value. One and only one of the value fields should be set. This is enforced in code.

Used in: Property, net.notdot.bdbdatastore.CompositeIndexKey, net.notdot.bdbdatastore.PropertyIndexKey

• optional int64 int64Value = 1

  primitives

• optional bool booleanValue = 2

• optional bytes stringValue = 3

• optional double doubleValue = 4

• optional group com.google.appengine.entity.PropertyValue.PointValue = 5

• optional group com.google.appengine.entity.PropertyValue.UserValue = 8

• optional group com.google.appengine.entity.PropertyValue.ReferenceValue = 12

composites. keep these in sync with the composites of the first-class PBs below.

Used in: PropertyValue

• required double x = 6

• required double y = 7

NOTE: Because of indexing restrictions, we cannot use the stand-alone Reference and Path PBs defined below. If you amend this group, amend those PB definitions in this file as well.

Used in: PropertyValue

• required string app = 13

• repeated group com.google.appengine.entity.PropertyValue.ReferenceValue.PathElement = 14

Used in: ReferenceValue

• required bytes type = 15

• optional int64 id = 16

  either name or id should be set

• optional bytes name = 17

Used in: PropertyValue

• required bytes email = 9

  the order of these fields matters. email is first so that users are sorted by email, using simple string comparison.

• required bytes auth_domain = 10

• optional string nickname = 11

• required int64 gaiaid = 18

An entity's primary key.

Used in: datastore_v3.DeleteRequest, datastore_v3.GetRequest, datastore_v3.PutResponse, datastore_v3.Query, EntityProto

• required string app = 13

• required Path path = 14

A Google Accounts user. Supports both regular and Google Apps For Your Domain accounts. The User and Reference composite types also have their own PB messages, so that we can use them in EntityProto.

Used in: EntityProto

• required bytes email = 1

  nickname is currently unused.

• required bytes auth_domain = 2

• optional string nickname = 3

• required int64 gaiaid = 4