Google Events
This repository contains types for CloudEvents issued by Google.
The "source of truth" for the event data format is in the form of Google Protocol Buffers.
See proto/README.md for more information about the messages used to describe CloudEvents.
Stability warning
The entire content of this repository should be regarded as highly
unstable until this warning is removed. The schema may change, the
CloudEvent "type" attribute values may change, the protobuf message
may change. Even the core cloud_event_type
annotation may change.
CloudEvents in this repository
This repository contains definitions for the following CloudEvents:
Package | Event types | Data messages |
---|---|---|
google.events.cloud.audit.v1 | google.cloud.audit.log.v1.written | LogEntryData |
google.events.cloud.cloudbuild.v1 | google.cloud.cloudbuild.build.v1.statusChanged | BuildEventData |
google.events.cloud.firestore.v1 | google.cloud.firestore.document.v1.created google.cloud.firestore.document.v1.deleted google.cloud.firestore.document.v1.updated google.cloud.firestore.document.v1.written |
DocumentEventData |
google.events.cloud.pubsub.v1 | google.cloud.pubsub.topic.v1.messagePublished | MessagePublishedData |
google.events.cloud.scheduler.v1 | google.cloud.scheduler.job.v1.executed | SchedulerJobData |
google.events.cloud.storage.v1 | google.cloud.storage.object.v1.archived google.cloud.storage.object.v1.deleted google.cloud.storage.object.v1.finalized google.cloud.storage.object.v1.metadataUpdated |
StorageObjectData |
google.events.firebase.analytics.v1 | google.firebase.analytics.log.v1.written | AnalyticsLogData |
google.events.firebase.auth.v1 | google.firebase.auth.user.v1.created google.firebase.auth.user.v1.deleted |
AuthEventData |
google.events.firebase.database.v1 | google.firebase.database.ref.v1.created google.firebase.database.ref.v1.deleted google.firebase.database.ref.v1.updated google.firebase.database.ref.v1.written |
ReferenceEventData |
google.events.firebase.remoteconfig.v1 | google.firebase.remoteconfig.remoteConfig.v1.updated | RemoteConfigEventData |
CloudEvent Type Repos
The following repositories contain data structures per language for types defined in this repo:
Contributing to this repository
Changes to this repository are expected to be performed after arriving at mutual consensus within Google (although pull requests may be used to arrive at that consensus).
Pull requests that involve a change to the event registry above must update this file accordingly, for consistency. This will be validated within the pull request checks. This can either be done by running the following commands below a machine with .NET Core SDK 3.1+ installed, or by making the changes manually:
./compile.sh
./generate-event-registry.sh tmp/protos.pb
Non-trivial changes to the schema should also include a suitable test data file (or a change to an existing test data file) to validate the change. See testdata/README.md for details.