Publier des événements directement

Avancé

Vous pouvez publier un événement CloudEvents directement sur un bus Eventarc Advanced dans un format compatible à l'aide de Google Cloud CLI ou en envoyant une requête à l'API REST Eventarc Publishing. Vous pouvez également utiliser les bibliothèques clientes Eventarc pour accéder aux API Eventarc à partir d'un langage compatible.

Avant de commencer

Avant de commencer, assurez-vous d'avoir effectué les étapes suivantes :

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

Publier directement

Le message d'événement que vous publiez directement doit être conforme à la spécification CloudEvents.

gcloud

1. Ouvrez un terminal.

2. Vous pouvez publier des événements sur un bus à l'aide de la commande gcloud eventarc message-buses publish. Exemple :

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

   ou
   gcloud eventarc message-buses publish BUS_NAME \
       --json-message=JSON_MESSAGE

   ou
   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

   Remplacez les éléments suivants :

   • BUS_NAME : ID ou identifiant complet du bus auquel publier l'événement.

   Vous ne devez utiliser qu'un seul des éléments suivants :

   • AVRO_MESSAGE : message d'événement au format Avro, conformément à cette spécification.
   • JSON_MESSAGE : message d'événement au format JSON, conformément à cette spécification.
   • DATA_PAYLOAD : données d'un événement publié.

   Si vous utilisez l'option --event-data, vous devez également utiliser les options suivantes :

   • EVENT_ID : identifiant de l'événement. Les producteurs d'événements doivent s'assurer que source + id est unique pour chaque événement distinct.
   • EVENT_SOURCE : source d'événement d'un événement publié.
   • EVENT_TYPE : type d'événement lié à l'occurrence d'origine.

   Si vous utilisez l'indicateur --event-data, vous pouvez éventuellement utiliser les éléments suivants :

   • EVENT_ATTRIBUTE : attributs d'un événement publié. Vous pouvez répéter l'option --event-attributes pour ajouter d'autres attributs.

     Notez que les événements peuvent inclure un nombre quelconque d'attributs CloudEvents personnalisés supplémentaires avec des noms distincts (également appelés attributs d'extension).

Exemples :

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"}
}'

API REST

Pour publier un événement dans un bus, utilisez la méthode projects.locations.messageBuses.publish.

Remarque : Dans le ProtoMessage du corps de la requête, le champ protoData ne fonctionne comme prévu que lorsque la charge utile est spécifiquement un type de message CloudEvent. Il ne peut pas être utilisé pour des messages de tampon de protocole arbitraires. Pour tout autre type de tampon de protocole, vous devez sérialiser votre message proto en octets et utiliser le champ binaryData à la place.

Avant d'utiliser les données de requête, effectuez les remplacements suivants :

• Nom complet de la ressource du bus au format projects/PROJECT_ID/locations/LOCATION/messageBuses/BUS_NAME

  Remplacez les éléments suivants :

  • PROJECT_ID : ID du projet de bus Google Cloud.
  • LOCATION : région dans laquelle le bus est déployé (par exemple, us-central1).
  • BUS_NAME : nom du bus auquel publier l'événement.
• SPEC_VERSION : version de la spécification CloudEvents utilisée par l'événement (par exemple, 1.0).
• EVENT_TYPE : type d'événement lié à l'occurrence d'origine.
• EVENT_SOURCE : source d'événement d'un événement publié.
• EVENT_ID : identifiant de l'événement. Les producteurs doivent s'assurer que source + id est unique pour chaque événement distinct.
• CONTENT_TYPE (facultatif) : type de contenu de la valeur data. Si un événement au format JSON ne comporte pas d'attribut datacontenttype, les données sont considérées comme une valeur JSON conforme au type de support application/json.
• DATA_PAYLOAD (facultatif) : charge utile de l'événement encodée au format multimédia spécifié par datacontenttype et respectant dataschema lorsque ces attributs sont présents.

Corps JSON de la requête :

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

Pour envoyer votre requête, développez l'une des options suivantes :

curl (Linux, macOS ou Cloud Shell)

Remarque : La commande suivante suppose que vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login, ou en utilisant Cloud Shell, qui vous connecte automatiquement à la CLI gcloud. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Enregistrez le corps de la requête dans un fichier nommé request.json. Exécutez la commande suivante dans le terminal pour créer ou écraser ce fichier dans le répertoire actuel :

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

Exécutez ensuite la commande suivante pour envoyer votre requête REST :

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)

Remarque : La commande suivante suppose que vous vous êtes connecté à la CLI gcloud avec votre compte utilisateur en exécutant la commande gcloud init ou gcloud auth login. Vous pouvez exécuter la commande gcloud auth list pour vérifier quel est le compte actuellement actif.

Enregistrez le corps de la requête dans un fichier nommé request.json. Exécutez la commande suivante dans le terminal pour créer ou écraser ce fichier dans le répertoire actuel :

@'
{
"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

Exécutez ensuite la commande suivante pour envoyer votre requête REST :

$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 (navigateur)

Copiez le corps de la requête et ouvrez la page de référence de la méthode. Le panneau APIs Explorer s'ouvre dans la partie droite de la page. Vous pouvez interagir avec cet outil pour envoyer des requêtes. Collez le corps de la requête dans cet outil, renseignez tous les champs obligatoires, puis cliquez sur Execute (Exécuter).

Si l'opération réussit, le serveur renvoie un code d'état HTTP 200 OK et le corps de réponse vide au format JSON :

200 OK

{}

Étapes suivantes

• Publier des événements provenant de sources Google
• Transformer les événements reçus
• Mettre en forme les événements reçus