/google-cloudevents

Types for CloudEvents issued by Google

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Google Events

Compile Validate JSON Schemas

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

The protobuf files in the proto directory should be regarded as stable with no further breaking changes. Other files such as generated JSON schema should not be regarded as stable.

CloudEvents in this repository

This repository contains definitions for the following CloudEvents:

Product Schemas Types
Cloud Audit Logs Proto / JSON
Data Type:
google.events.cloud.audit.v1.LogEntryData
CloudEvent Type(s):
google.cloud.audit.log.v1.written
Cloud Build Proto / JSON
Data Type:
google.events.cloud.cloudbuild.v1.BuildEventData
CloudEvent Type(s):
google.cloud.cloudbuild.build.v1.statusChanged
Cloud Firestore Proto / JSON
Data Type:
google.events.cloud.firestore.v1.DocumentEventData
CloudEvent Type(s):
google.cloud.firestore.document.v1.created
google.cloud.firestore.document.v1.updated
google.cloud.firestore.document.v1.deleted
google.cloud.firestore.document.v1.written
Cloud Pub/Sub Proto / JSON
Data Type:
google.events.cloud.pubsub.v1.MessagePublishedData
CloudEvent Type(s):
google.cloud.pubsub.topic.v1.messagePublished
Cloud Scheduler Proto / JSON
Data Type:
google.events.cloud.scheduler.v1.SchedulerJobData
CloudEvent Type(s):
google.cloud.scheduler.job.v1.executed
Cloud Storage Proto / JSON
Data Type:
google.events.cloud.storage.v1.StorageObjectData
CloudEvent Type(s):
google.cloud.storage.object.v1.finalized
google.cloud.storage.object.v1.archived
google.cloud.storage.object.v1.deleted
google.cloud.storage.object.v1.metadataUpdated
Google Analytics for Firebase Proto / JSON
Data Type:
google.events.firebase.analytics.v1.AnalyticsLogData
CloudEvent Type(s):
google.firebase.analytics.log.v1.written
Firebase Authentication Proto / JSON
Data Type:
google.events.firebase.auth.v1.AuthEventData
CloudEvent Type(s):
google.firebase.auth.user.v1.created
google.firebase.auth.user.v1.deleted
Firebase Realtime Database Proto / JSON
Data Type:
google.events.firebase.database.v1.ReferenceEventData
CloudEvent Type(s):
google.firebase.database.ref.v1.created
google.firebase.database.ref.v1.updated
google.firebase.database.ref.v1.deleted
google.firebase.database.ref.v1.written
Firebase Alerts Proto / JSON
Data Type:
google.events.firebase.firebasealerts.v1.AlertData
CloudEvent Type(s):
google.firebase.firebasealerts.alerts.v1.published
Firebase Remote Config Proto / JSON
Data Type:
google.events.firebase.remoteconfig.v1.RemoteConfigEventData
CloudEvent Type(s):
google.firebase.remoteconfig.remoteConfig.v1.updated
Firebase Test Lab Proto / JSON
Data Type:
google.events.firebase.testlab.v1.TestMatrixEventData
CloudEvent Type(s):
google.firebase.testlab.testMatrix.v1.completed

Google CloudEvent Catalogs

This repository contains catalogs for Google CloudEvent event discovery:

Google CloudEvent JSON Schema catalog

Link: catalog.json

A machine-readable list of Google CloudEvent JSON schemas. In the format of a JSON Schema catalog.

Cloud Audit Log catalog

Link: AUDIT_CATALOG.md

A human-readable list of Audit Log methodName and serviceName event filters.

Used for filtering events of type google.cloud.audit.log.v1.written.

Google CloudEvent Type Libraries

The following repositories contain data structures per language for types defined in this repo: