CloudEvents - Formato evento JSON

CloudEvents (cloudevents.io) è una specifica per descrivere i dati degli eventi in modo comune. La specifica è sotto la Cloud Native Computing Foundation (CNCF) ed è organizzata dal gruppo di lavoro serverless della CNCF.

Eventarc invia gli eventi al ricevitore di eventi nel formato CloudEvents tramite una richiesta HTTP. La destinazione, ad esempio il servizio Workflows, converte l'evento in un oggetto JSON (in base alla specifica CloudEvents) e lo passa all'esecuzione del flusso di lavoro come argomento runtime del flusso di lavoro.

Formato del payload JSON

Il servizio di destinazione riceve eventi dai router di eventi e li formatta nel formato evento JSON per CloudEvents versione 1.0.1 con i seguenti attributi CloudEvents:

{
  "subscription": "projects/my-project/subscriptions/my-sub",
  "message": {
    "attributes": {
      "attr1":"attr1-value"
    },
    "data": "aGVsbG8gd29ybGQ=",
    "messageId": "2070443601311540",
    "publishTime":"2021-02-26T19:13:55.749Z"
  }
}

A seconda del tipo di evento, il formato del payload è il seguente:

{
  "data":{ EVENT_DATA },
  "datacontenttype": "application/json; charset=utf-8",
  "id": "MESSAGE_ID",
  "source": "//cloudaudit.googleapis.com/projects/PROJECT_ID/logs/data_access",
  "specversion": "1.0",
  "type": "google.cloud.audit.log.v1.written",
  "time": "EVENT_GENERATION_TIME",
  "dataschema": "https://googleapis.github.io/google-cloudevents/jsonschema/google/events/cloud/audit/v1/LogEntryData.json",
  "methodName": "jobservice.jobcompleted",
  "resourceName": "projects/my-project/jobs/bqjob_r3ac45813612fa2d6_0000017d591922c9_1",
  "serviceName": "bigquery.googleapis.com",
  "subject": "bigquery.googleapis.com/projects/my-project/jobs/bqjob_r3ac45813612fa2d6_0000017d591922c9_1"
}

{
  "data":{ EVENT_DATA },
  "datacontenttype": "application/json",
  "id": "MESSAGE_ID",
  "source": "//storage.googleapis.com/projects/_/buckets/BUCKET_NAME",
  "specversion": "1.0",
  "type": "google.cloud.storage.object.v1.finalized",
  "time": "EVENT_GENERATION_TIME",
  "subject": "objects/my-file.txt"
}

{
  "data":{ EVENT_DATA },
  "datacontenttype": "application/json; charset=utf-8",
  "id": "MESSAGE_ID",
  "source": "//pubsub.googleapis.com/TOPIC_NAME",
  "specversion": "1.0",
  "type": "google.cloud.pubsub.topic.v1.messagePublished",
  "time": "EVENT_GENERATION_TIME"
}

Repository open source

La struttura del corpo HTTP per tutti gli eventi è disponibile nel repository GitHub CloudEvents.

Il repository contiene quanto segue per aiutarti a comprendere e utilizzare i dati CloudEvents nel tuo linguaggio di programmazione:

• Google Protocol Buffers per i payload di dati CloudEvents
• Schemi JSON generati
• Un catalogo pubblico di schemi JSON

Sono inclusi anche i link alle librerie client.

Eventi comuni

I protocol buffer (o protobuf) rappresentano i dati all'interno degli eventi generati da Eventarc. I buffer di protocollo per CloudEvents vengono forniti come schemi leggibili automaticamente, consentendo la creazione di librerie di tipi di dati e semplificando l'utilizzo degli eventi.

Esistono due messaggi protobuf pertinenti per un determinato tipo di CloudEvent:

• Il messaggio envelope che rappresenta l'intero CloudEvent, inclusi eventuali attributi di estensione; ad esempio, AuditLogWrittenEvent.
• Il messaggio data; ad esempio, LogEntryData o StorageObjectData.

Le tabelle seguenti descrivono in dettaglio i componenti di alcuni eventi comuni: