Memublikasikan peristiwa secara langsung

Lanjutan

Anda dapat memublikasikan peristiwa CloudEvents langsung ke bus Eventarc Advanced dalam format yang didukung menggunakan Google Cloud CLI atau dengan mengirim permintaan ke Eventarc Publishing REST API. Anda juga dapat menggunakan library klien Eventarc untuk mengakses API Eventarc dari bahasa yang didukung.

Sebelum memulai

Sebelum memulai, pastikan Anda telah menyelesaikan langkah-langkah berikut:

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

Publikasikan secara langsung

Pesan peristiwa yang Anda publikasikan secara langsung harus sesuai dengan spesifikasi CloudEvents.

gcloud

1. Buka terminal.

2. Anda dapat memublikasikan peristiwa ke bus menggunakan perintah gcloud eventarc message-buses publish. Contoh:

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

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

   Atau:
   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

   Ganti kode berikut:

   • BUS_NAME: ID atau ID yang memenuhi syarat sepenuhnya dari bus tempat memublikasikan peristiwa.

   Anda hanya boleh menggunakan salah satu opsi berikut:

   • AVRO_MESSAGE: pesan peristiwa dalam format Avro sesuai dengan spesifikasi ini.
   • JSON_MESSAGE: pesan peristiwa dalam format JSON sesuai dengan spesifikasi ini.
   • DATA_PAYLOAD: data peristiwa yang dipublikasikan.

   Jika menggunakan flag --event-data, Anda juga harus menggunakan yang berikut:

   • EVENT_ID: ID peristiwa. Produser acara harus memastikan bahwa source + id bersifat unik untuk setiap acara yang berbeda.
   • EVENT_SOURCE: sumber peristiwa dari peristiwa yang dipublikasikan.
   • EVENT_TYPE: jenis peristiwa yang terkait dengan kejadian awal.

   Jika menggunakan flag --event-data, Anda dapat menggunakan opsi berikut:

   • EVENT_ATTRIBUTE: atribut peristiwa yang dipublikasikan. Anda dapat mengulangi tanda --event-attributes untuk menambahkan lebih banyak atribut.

     Perhatikan bahwa peristiwa dapat mencakup sejumlah atribut CloudEvents kustom tambahan dengan nama yang berbeda (juga dikenal sebagai atribut ekstensi).

Contoh:

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

Untuk memublikasikan peristiwa ke bus, gunakan metode projects.locations.messageBuses.publish.

Catatan: Di ProtoMessage isi permintaan, kolom protoData hanya berfungsi seperti yang diharapkan jika payloadnya adalah jenis pesan CloudEvent secara khusus, dan tidak dapat digunakan untuk pesan buffer protokol arbitrer. Untuk jenis buffer protokol lainnya, Anda harus melakukan serialisasi pesan proto ke byte, dan menggunakan kolom binaryData sebagai gantinya.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• Nama lengkap resource bus dalam format projects/PROJECT_ID/locations/LOCATION/messageBuses/BUS_NAME

  Ganti kode berikut:

  • PROJECT_ID: Google Cloud project ID untuk project bus.
  • LOCATION: region tempat bus di-deploy—misalnya, us-central1.
  • BUS_NAME: nama bus tempat memublikasikan peristiwa.
• SPEC_VERSION: versi spesifikasi CloudEvents yang digunakan peristiwa—misalnya, 1.0.
• EVENT_TYPE: jenis peristiwa yang terkait dengan kemunculan asal.
• EVENT_SOURCE: sumber peristiwa dari peristiwa yang dipublikasikan.
• EVENT_ID: ID peristiwa. Produser harus memastikan bahwa source + id bersifat unik untuk setiap acara yang berbeda.
• CONTENT_TYPE (opsional): jenis konten nilai data. Jika peristiwa format JSON tidak memiliki atribut datacontenttype, maka diasumsikan bahwa data adalah nilai JSON yang sesuai dengan jenis media application/json.
• DATA_PAYLOAD (opsional): payload peristiwa yang dienkode ke dalam format media yang ditentukan oleh datacontenttype dan mematuhi dataschema jika atribut tersebut ada.

Meminta isi JSON:

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

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

curl (Linux, macOS, atau Cloud Shell)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login, atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI. Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json. Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:

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

Kemudian jalankan perintah berikut untuk mengirim permintaan REST Anda:

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)

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login. Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

Simpan isi permintaan dalam file bernama request.json. Jalankan perintah berikut di terminal untuk membuat atau menimpa file ini di direktori saat ini:

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

Kemudian jalankan perintah berikut untuk mengirim permintaan REST Anda:

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

Salin isi permintaan dan buka halaman referensi metode. Panel APIs Explorer terbuka di sisi kanan halaman. Anda bisa berinteraksi dengan alat ini untuk mengirim permintaan. Tempelkan isi permintaan di alat ini, lengkapi kolom lainnya yang wajib diisi, lalu klik Jalankan.

Jika berhasil, server akan menampilkan kode status HTTP 200 OK dan isi respons kosong dalam format JSON:

200 OK

{}

Langkah berikutnya

• Memublikasikan acara dari sumber Google
• Mentransformasi peristiwa yang diterima
• Memformat peristiwa yang diterima