package google.events.cloud.firestore.v1

Get desktop application:
View/edit binary Protocol Buffers messages

An array value.

Used in: Value

• repeated Value values = 1

  Values in the array.

A Firestore document.

Used in: DocumentEventData

• string name = 1

  The resource name of the document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`

• map<string, Value> fields = 2

  The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.

• optional protobuf.Timestamp create_time = 3

  The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.

• optional protobuf.Timestamp update_time = 4

  The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query.

The CloudEvent raised when a Firestore document is created.

• optional DocumentEventData data = 1

  The data associated with the event.

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

• optional DocumentEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Firestore document is deleted.

• optional DocumentEventData data = 1

  The data associated with the event.

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

• optional DocumentEventData data = 1

  The data associated with the event.

The data within all Firestore document events.

Used in: DocumentCreatedEvent, DocumentCreatedEventWithAuthContext, DocumentDeletedEvent, DocumentDeletedEventWithAuthContext, DocumentUpdatedEvent, DocumentUpdatedEventWithAuthContext, DocumentWrittenEvent, DocumentWrittenEventWithAuthContext

• optional Document value = 1

  A Document object containing a post-operation document snapshot. This is not populated for delete events.

• optional Document old_value = 2

  A Document object containing a pre-operation document snapshot. This is only populated for update and delete events.

• optional DocumentMask update_mask = 3

  A DocumentMask object that lists changed fields. This is only populated for update events.

A set of field paths on a document.

Used in: DocumentEventData

• repeated string field_paths = 1

  The list of field paths in the mask. See [Document.fields][google.cloud.firestore.v1.events.Document.fields] for a field path syntax reference.

The CloudEvent raised when a Firestore document is updated.

• optional DocumentEventData data = 1

  The data associated with the event.

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

• optional DocumentEventData data = 1

  The data associated with the event.

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

• optional DocumentEventData data = 1

  The data associated with the event.

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

• optional DocumentEventData data = 1

  The data associated with the event.

A map value.

Used in: Value

• map<string, Value> fields = 1

  The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.

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

Used in: ArrayValue, Document, MapValue

• 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. Precise only to microseconds. When stored, any additional precision is rounded down.

  • string string_value = 17

    A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

  • bytes bytes_value = 18

    A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

  • string reference_value = 5

    A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

  • type.LatLng geo_point_value = 8

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

  • ArrayValue array_value = 9

    An array value. Cannot directly contain another array value, though can contain an map which contains another array.

  • MapValue map_value = 6

    A map value.