Ereignisse direkt veröffentlichen

Erweitert

Sie können ein CloudEvents-Ereignis mit der Google Cloud CLI oder durch Senden einer Anfrage an die Eventarc Publishing REST API in einem unterstützten Format direkt in einem Eventarc Advanced-Bus veröffentlichen. Sie können auch die Eventarc-Clientbibliotheken verwenden, um in einer unterstützten Sprache auf die Eventarc APIs zuzugreifen.

Hinweise

Führen Sie die folgenden Schritte aus, bevor Sie beginnen:

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

Create or select a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

• Create a Google Cloud project:

  gcloud projects create PROJECT_ID

  Replace PROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set project PROJECT_ID

  Replace PROJECT_ID with your Google Cloud project name.

Verify that billing is enabled for your Google Cloud project.

Enable the Eventarc and Eventarc Publishing APIs:

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

gcloud services enable eventarc.googleapis.com eventarcpublishing.googleapis.com

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

Create or select a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

• Create a Google Cloud project:

  gcloud projects create PROJECT_ID

  Replace PROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set project PROJECT_ID

  Replace PROJECT_ID with your Google Cloud project name.

Verify that billing is enabled for your Google Cloud project.

Enable the Eventarc and Eventarc Publishing APIs:

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

gcloud services enable eventarc.googleapis.com eventarcpublishing.googleapis.com

Direkt veröffentlichen

Die Ereignisnachricht, die Sie direkt veröffentlichen, muss der CloudEvents-Spezifikation entsprechen.

gcloud

1. Öffnen Sie ein Terminalfenster.

2. Sie können Ereignisse mit dem Befehl gcloud eventarc message-buses publish in einem Bus veröffentlichen. Beispiel:

   gcloud eventarc message-buses publish BUS_NAME \
       --avro-message=AVRO_MESSAGE

   oder:
   gcloud eventarc message-buses publish BUS_NAME \
       --json-message=JSON_MESSAGE

   oder:
   gcloud eventarc message-buses publish BUS_NAME \
       --event-data=DATA_PAYLOAD \
       --event-id=EVENT_ID \
       --event-source=EVENT_SOURCE \
       --event-type=EVENT_TYPE \
       --event-attributes=EVENT_ATTRIBUTE

   Ersetzen Sie Folgendes:

   • BUS_NAME: die ID oder voll qualifizierte Kennzeichnung des Busses, in dem das Ereignis veröffentlicht werden soll.

   Sie dürfen nur eines der folgenden Elemente verwenden:

   • AVRO_MESSAGE: Die Ereignismeldung im Avro-Format gemäß dieser Spezifikation.
   • JSON_MESSAGE: die Ereignisnachricht im JSON-Format gemäß dieser Spezifikation.
   • DATA_PAYLOAD: die Daten eines veröffentlichten Ereignisses.

   Wenn Sie das Flag --event-data verwenden, müssen Sie auch Folgendes verwenden:

   • EVENT_ID: die Ereignis-ID. Ereignisproduzenten müssen dafür sorgen, dass source + id für jedes einzelne Ereignis eindeutig ist.
   • EVENT_SOURCE: Die Ereignisquelle eines veröffentlichten Ereignisses.
   • EVENT_TYPE: Der Ereignistyp, der sich auf das ursprüngliche Ereignis bezieht.

   Wenn Sie das Flag --event-data verwenden, können Sie optional Folgendes verwenden:

   • EVENT_ATTRIBUTE: die Attribute eines veröffentlichten Ereignisses. Sie können das Flag --event-attributes wiederholen, um weitere Attribute hinzuzufügen.

     Ereignisse können beliebig viele zusätzliche benutzerdefinierte CloudEvents-Attribute mit unterschiedlichen Namen (auch als Erweiterungsattribute bezeichnet) enthalten.

Beispiele:

gcloud eventarc message-buses publish my-bus \
    --event-data='{"key": "hello-world-data"}' \
    --event-id=hello-world-id-1234 \
    --event-source=hello-world-source \
    --event-type=hello-world-type \
    --event-attributes="datacontenttype=application/json"

gcloud eventarc message-buses publish my-bus --json-message='{
    "specversion" : "1.0",
    "type" :"com.example.someevent",
    "source" : "google.cloud.storage.object.v1.finalized",
    "id" : "A234-1234-1234",
    "time" : "2024-04-05T17:31:00Z",
    "bucket" : "bucketName",
    "datacontenttype" : "application/json",
    "data":{"key": "value"}
}'

REST API

Verwenden Sie zum Veröffentlichen eines Ereignisses in einem Bus die Methode projects.locations.messageBuses.publish.

Hinweis :Im ProtoMessage des Anfragetexts funktioniert das Feld protoData nur wie erwartet, wenn die Nutzlast speziell ein CloudEvent-Nachrichtentyp ist. Es kann nicht für beliebige Protocol Buffer-Nachrichten verwendet werden. Für alle anderen Protokollpuffertypen müssen Sie Ihre Proto-Nachricht in Bytes serialisieren und stattdessen das Feld binaryData verwenden.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

• Der vollständige Ressourcenname des Busses im Format projects/PROJECT_ID/locations/LOCATION/messageBuses/BUS_NAME

  Ersetzen Sie Folgendes:

  • PROJECT_ID: die Google Cloud-Projekt-ID für das Bus-Projekt.
  • LOCATION: die Region, in der der Bus bereitgestellt wird, z. B. us-central1.
  • BUS_NAME: Der Name des Busses, an den das Ereignis gesendet werden soll.
• SPEC_VERSION: Die Version der CloudEvents-Spezifikation, die für das Ereignis verwendet wird, z. B. 1.0.
• EVENT_TYPE: Der Ereignistyp, der sich auf das ursprüngliche Ereignis bezieht.
• EVENT_SOURCE: die Ereignisquelle eines veröffentlichten Ereignisses.
• EVENT_ID: die Ereignis-ID. Feedersteller müssen dafür sorgen, dass source + id für jedes einzelne Event eindeutig ist.
• CONTENT_TYPE (optional): Der Inhaltstyp des data-Werts. Wenn ein Ereignis im JSON-Format kein datacontenttype-Attribut hat, wird davon ausgegangen, dass die Daten ein JSON-Wert sind, der dem Medientyp application/json entspricht.
• DATA_PAYLOAD (optional): Die Ereignisnutzlast, die in das durch datacontenttype angegebene Media-Format codiert ist und dataschema entspricht, wenn diese Attribute vorhanden sind.

JSON-Text der Anfrage:

{
"jsonMessage":
  "{\"specversion\":\"SPEC_VERSION\",
  \"type\":\"EVENT_TYPE\",
  \"source\":\"EVENT_SOURCE\",
  \"id\":\"EVENT_ID\",
  \"datacontenttype\":\"CONTENT_TYPE\",
  \"data\":\"DATA_PAYLOAD\"}"
}

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

curl (Linux, macOS oder Cloud Shell)

Hinweis: Der folgende Befehl setzt voraus, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben, indem Sie gcloud init oder gcloud auth login ausgeführt oder die Cloud Shell genutzt haben, die Sie automatisch in der gcloud-Befehlszeile anmeldet. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json. Führen Sie folgenden Befehl im Terminal aus, um diese Datei im aktuellen Verzeichnis zu erstellen oder zu überschreiben:

cat > request.json << 'EOF'
{
"jsonMessage":
  "{\"specversion\":\"SPEC_VERSION\",
  \"type\":\"EVENT_TYPE\",
  \"source\":\"EVENT_SOURCE\",
  \"id\":\"EVENT_ID\",
  \"datacontenttype\":\"CONTENT_TYPE\",
  \"data\":\"DATA_PAYLOAD\"}"
}
EOF

Führen Sie dann folgenden Befehl aus, um Ihre REST-Anfrage zu senden:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://eventarcpublishing.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/messageBuses/BUS_NAME:publish"

PowerShell (Windows)

Hinweis: Der folgende Befehl setzt voraus, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben, indem Sie gcloud init oder gcloud auth login ausgeführt haben. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json. Führen Sie folgenden Befehl im Terminal aus, um diese Datei im aktuellen Verzeichnis zu erstellen oder zu überschreiben:

@'
{
"jsonMessage":
  "{\"specversion\":\"SPEC_VERSION\",
  \"type\":\"EVENT_TYPE\",
  \"source\":\"EVENT_SOURCE\",
  \"id\":\"EVENT_ID\",
  \"datacontenttype\":\"CONTENT_TYPE\",
  \"data\":\"DATA_PAYLOAD\"}"
}
'@  | Out-File -FilePath request.json -Encoding utf8

Führen Sie dann folgenden Befehl aus, um Ihre REST-Anfrage zu senden:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://eventarcpublishing.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/messageBuses/BUS_NAME:publish" | Select-Object -Expand Content

APIs Explorer (Browser)

Kopieren Sie den Anfragetext und öffnen Sie die Referenzseite für Methoden. Der API Explorer wird rechts auf der Seite geöffnet. Sie können mit diesem Tool interagieren, um Anfragen zu senden. Fügen Sie den Anfragetext in dieses Tool ein, füllen Sie alle Pflichtfelder aus und klicken Sie auf Ausführen.

Bei Erfolg gibt der Server den HTTP-Statuscode 200 OK und den leeren Antworttext im JSON-Format zurück:

200 OK

{}

Nächste Schritte

• Ereignisse aus Google-Quellen veröffentlichen
• Empfangene Ereignisse transformieren
• Empfangene Ereignisse formatieren