package google.events.cloud.datastore.v1

Get desktop application:
View/edit binary Protocol Buffers messages

An array value.

Used in: Value

• repeated Value values = 1

  Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.

A Datastore data object. Must not exceed 1 MiB - 4 bytes.

Used in: EntityResult, Value

• optional Key key = 1

  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.

• map<string, Value> properties = 3

  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.

The CloudEvent is raised when a Firestore entity is created.

• optional EntityEventData data = 1

  The data associated with the event.

The CloudEvent with Auth Context is raised when a Firestore entity is created.

• optional EntityEventData data = 1

  The data associated with the event.

The CloudEvent is raised when a Firestore entity is deleted.

• optional EntityEventData data = 1

  The data associated with the event.

The CloudEvent with Auth Context is raised when a Firestore entity is deleted.

• optional EntityEventData data = 1

  The data associated with the event.

The data within all Firestore in Datastore Mode entity events.

Used in: EntityCreatedEvent, EntityCreatedEventWithAuthContext, EntityDeletedEvent, EntityDeletedEventWithAuthContext, EntityUpdatedEvent, EntityUpdatedEventWithAuthContext, EntityWrittenEvent, EntityWrittenEventWithAuthContext

• optional EntityResult value = 1

  An EntityResult object containing a post-operation entity snapshot. This is not populated for delete events.

• optional EntityResult old_value = 2

  An EntityResult object containing a pre-operation entity snapshot. This is only populated for update and delete events.

• optional PropertyMask update_mask = 3

  A PropertyMask object that lists changed properties. This is only populated for update events..

The result of fetching an entity from Datastore.

Used in: EntityEventData

• optional Entity entity = 1

  The resulting entity.

• int64 version = 4

  The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for [`FULL`][google.datastore.v1.EntityResult.ResultType.FULL] entity results. For [missing][google.datastore.v1.LookupResponse.missing] entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.

• optional protobuf.Timestamp create_time = 6

  The time at which the entity was created. This field is set for [`FULL`][google.datastore.v1.EntityResult.ResultType.FULL] entity results. If this entity is missing, this field will not be set.

• optional protobuf.Timestamp update_time = 5

  The time at which the entity was last changed. This field is set for [`FULL`][google.datastore.v1.EntityResult.ResultType.FULL] entity results. If this entity is missing, this field will not be set.

• bytes cursor = 3

  A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.

Specifies what data the 'entity' field contains. A `ResultType` is either implied (for example, in `LookupResponse.missing` from `datastore.proto`, it is always `KEY_ONLY`) or specified by context (for example, in message `QueryResultBatch`, field `entity_result_type` specifies a `ResultType` for all the values in field `entity_results`).

• RESULT_TYPE_UNSPECIFIED = 0

  Unspecified. This value is never used.

• FULL = 1

  The key and properties.

• PROJECTION = 2

  A projected subset of properties. The entity may have no key.

• KEY_ONLY = 3

  Only the key.

The CloudEvent is raised when a Firestore entity is updated.

• optional EntityEventData data = 1

  The data associated with the event.

The CloudEvent with Auth Context is raised when a Firestore entity is updated.

• optional EntityEventData data = 1

  The data associated with the event.

The CloudEvent is raised when a Firestore entity is created, updated or deleted.

• optional EntityEventData data = 1

  The data associated with the event.

The CloudEvent with Auth Context is raised when a Firestore entity is created, updated or deleted.

• optional EntityEventData data = 1

  The data associated with the event.

A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.

Used in: Entity, Value

• optional PartitionId partition_id = 1

  Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.

• repeated Key.PathElement path = 2

  The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.

A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.

Used in: Key

• string kind = 1

  The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the bytes.

• oneof id_type

  The type of ID.

  • int64 id = 2

    The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.

  • string name = 3

    The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the bytes.

A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.

Used in: Key

• string project_id = 2

  The ID of the project to which the entities belong.

• string database_id = 3

  If not empty, the ID of the database to which the entities belong.

• string namespace_id = 4

  If not empty, the ID of the namespace to which the entities belong.

A set of property paths on an entity.

Used in: EntityEventData

• repeated string property_paths = 1

  The list of property paths in the mask. This is not populated for delete events.

A message that can hold any of the supported value types and associated metadata.

Used in: ArrayValue, Entity

• oneof value_type

  Must have a value set.

  • protobuf.NullValue null_value = 11

    A null value.

  • bool boolean_value = 1

    A boolean value.

  • int64 integer_value = 2

    An integer value.

  • double double_value = 3

    A double value.

  • protobuf.Timestamp timestamp_value = 10

    A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

  • Key key_value = 5

    A key value.

  • string string_value = 17

    A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

  • bytes blob_value = 18

    A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.

  • type.LatLng geo_point_value = 8

    A geo point value representing a point on the surface of Earth.

  • Entity entity_value = 6

    An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.

  • ArrayValue array_value = 9

    An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.

• int32 meaning = 14

  The `meaning` field should only be populated for backwards compatibility.

• bool exclude_from_indexes = 19

  If the value should be excluded from all indexes including those defined explicitly.