イベントを直接公開する

詳細設定

CloudEvents イベントをサポートされている形式で Eventarc Advanced バスに直接パブリッシュするには、Google Cloud CLI を使用するか、Eventarc Publishing REST API にリクエストを送信します。Eventarc クライアント ライブラリを使用して、サポートされている言語から Eventarc API にアクセスすることもできます。

始める前に

まだ有効にしていない場合は、Eventarc API と Eventarc Publishing API を有効にします。

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

直接公開する

直接公開するイベント メッセージは、CloudEvents 仕様に準拠している必要があります。

gcloud

1. ターミナルを開きます。

2. gcloud eventarc message-buses publish コマンドを使用して、イベントをバスに公開できます。次に例を示します。

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

   または
   gcloud eventarc message-buses publish BUS_NAME \
       --json-message=JSON_MESSAGE

   または
   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

   次のように置き換えます。

   • BUS_NAME: イベントのパブリッシュ先のバスの ID または完全修飾識別子。

   次のいずれか 1 つだけを使用する必要があります。

   • AVRO_MESSAGE: この仕様に従った Avro 形式のイベント メッセージ。
   • JSON_MESSAGE: この仕様に準拠した JSON 形式のイベント メッセージ。
   • DATA_PAYLOAD: 公開されたイベントのデータ。

   --event-data フラグを使用する場合は、次のものも使用する必要があります。

   • EVENT_ID: イベント ID。イベント プロデューサーは、source + id がイベントごとに一意であることを確認する必要があります。
   • EVENT_SOURCE: 公開されたイベントのイベントソース。
   • EVENT_TYPE: 元の発生に関連するイベントのタイプ。

   --event-data フラグを使用する場合は、必要に応じて次のものを使用できます。

   • EVENT_ATTRIBUTE: 公開されたイベントの属性。--event-attributes フラグを繰り返して、属性を追加できます。

     イベントには、異なる名前のカスタム CloudEvents 属性（拡張属性とも呼ばれます）がいくつでも含まれる場合があります。

例:

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

イベントをバスにパブリッシュするには、projects.locations.messageBuses.publish メソッドを使用します。

注: リクエスト本文の ProtoMessage では、ペイロードが CloudEvent メッセージ タイプの場合にのみ protoData フィールドが想定どおりに機能します。任意のプロトコル バッファ メッセージには使用できません。他のプロトコル バッファ型の場合は、proto メッセージをバイトにシリアル化し、代わりに binaryData フィールドを使用する必要があります。

リクエストのデータを使用する前に、次のように置き換えます。

• バスの完全なリソース名（projects/PROJECT_ID/locations/LOCATION/messageBuses/BUS_NAME 形式）。

  次のように置き換えます。

  • PROJECT_ID: バス プロジェクトの Google Cloudプロジェクト ID。
  • LOCATION: バスがデプロイされているリージョン（例: us-central1）。
  • BUS_NAME: イベントを公開するバスの名前。
• SPEC_VERSION: イベントで使用される CloudEvents 仕様のバージョン（例: 1.0）。
• EVENT_TYPE: 元の発生に関連するイベントのタイプ。
• EVENT_SOURCE: 公開されたイベントのイベントソース。
• EVENT_ID: イベントの識別子。プロデューサーは、source と id がイベントごとに一意であることを確認する必要があります。
• CONTENT_TYPE（省略可）: data 値のコンテンツ タイプ。JSON 形式のイベントに datacontenttype 属性がない場合、データは application/json メディアタイプに準拠した JSON 値であると見なされます。
• DATA_PAYLOAD（省略可）: datacontenttype で指定されたメディア形式にエンコードされ、それらの属性が存在する場合は dataschema に準拠するイベント ペイロード。

リクエストの本文（JSON）:

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

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存します。ターミナルで次のコマンドを実行して、このファイルを現在のディレクトリに作成または上書きします。

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

その後、次のコマンドを実行して 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）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存します。ターミナルで次のコマンドを実行して、このファイルを現在のディレクトリに作成または上書きします。

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

その後、次のコマンドを実行して 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

API Explorer（ブラウザ）

リクエスト本文をコピーして、メソッドのリファレンス ページを開きます。ページの右側に [API Explorer] パネルが開きます。このツールを操作してリクエストを送信できます。このツールにリクエスト本文を貼り付け、その他の必須フィールドに入力して、[Execute] をクリックします。

成功した場合、サーバーは HTTP 200 OK ステータス コードと JSON 形式の空のレスポンス本文を返します。

200 OK

{}

次のステップ

• Google ソースからイベントを公開する
• 受信したイベントを変換する
• 受信したイベントの形式を設定する