イベントを受信する登録を作成する

パイプライン

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

2. gcloud beta eventarc pipelines create コマンドを使用してパイプラインを作成します。

   gcloud beta eventarc pipelines create PIPELINE_NAME \
       --destinations=DESTINATION_KEY \
       --location=LOCATION

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

   • PIPELINE_NAME: パイプラインの ID または完全修飾名

   • DESTINATION_KEY: パイプラインの宛先を構成する 1 つ以上の Key-Value ペア

     次のキーのうちいずれか 1 つを設定する必要があります。

     • http_endpoint_uri - 宛先 URI。ホストは、Virtual Private Cloud（VPC）ネットワークからアドレス指定可能な静的 IP アドレスか、Cloud DNS を使用して解決可能なサービスの内部ドメイン ネーム システム（DNS）ホスト名のいずれかです。必要に応じて、http_endpoint_message_binding_template を設定してメッセージ バインディングを指定することもできます。

       このキーを使用して、HTTP POST リクエストとしてイベントを受信する Cloud Run 関数、Cloud Run ジョブ、または Cloud Run サービスをターゲットにできます。

     • message_bus - Eventarc Advanced バスの ID。

     • pubsub_topic - Pub/Sub トピックの ID。

     • workflow - Workflows ワークフローの ID。

     http_endpoint_uri のみ（Cloud Run URL を含む）の場合は、次のキーを設定する必要があります。

     • network_attachment - プロデューサー VPC ネットワークがコンシューマー VPC ネットワークへの接続を開始できるようにするリソース。イベントを公開するために、Eventarc Advanced はネットワーク アタッチメントを使用して、VPC ネットワークでホストされているエンドポイントとの接続を確立します。

       ネットワーク アタッチメントを参照する Private Service Connect インターフェースからの接続を自動的に受け入れるネットワーク アタッチメントを作成できます。宛先リソースを含むネットワークとリージョンにネットワーク アタッチメントを作成します。

       DNS アドレス（Cloud Run など）を使用してメッセージを Google の宛先に転送する場合は、ネットワーク アタッチメントで使用されるサブネットで限定公開の Google アクセスが有効になっていることを確認してください。そうしないと、DNS アドレスを解決できません。

     認証を有効にするには、次のいずれかのキーを設定します。

     • google_oidc_authentication_service_account - OIDC トークンの生成に使用されるサービス アカウントのメールアドレス。このトークンは、トークンを自分で検証するエンドポイントなど、さまざまなシナリオで使用できます。必要に応じて、google_oidc_authentication_audience を設定して、このトークンの対象となるオーディエンスを指定できます。通常は、ターゲット パイプラインの URL と一致する必要があります。指定しない場合は、リクエスト パラメータを含む URL 全体が使用されます。

       Cloud Run はリクエストごとに IAM チェックを実行します。run.routes.invoke 権限を使用して、次のいずれかの方法で Cloud Run サービスにアクセスできるユーザーを構成できます。

       • サービス アカウントまたはグループを選択して、サービスへのアクセスを許可する権限を付与します。すべてのリクエストには、いずれかの承認済みサービス アカウント用に Google によって署名された OpenID Connect トークンを含む HTTP 認証ヘッダーが必要です。

       • 未承認のアクセスを許可する allUsers に権限を付与します。

       詳細については、Cloud Run のアクセス制御 をご覧ください。

     • oauth_token_authentication_service_account - OAuth トークンの生成に使用されるサービス アカウントのメールアドレス。通常、*.googleapis.com でホストされている Google API を呼び出す場合にのみ使用されます。必要に応じて、oauth_token_authentication_scope を設定してこのトークンのスコープを指定できます。指定しない場合、デフォルトは https://www.googleapis.com/auth/cloud-platform になります。Google Cloud サービスの場合は、すべての Google Cloud API を含む https://www.googleapis.com/auth/cloud-platform スコープとともに、きめ細かなアクセス制御を行える Identity and Access Management（IAM）を使用することをおすすめします。

       別の Eventarc Advanced バス、Pub/Sub、Workflows へのすべてのリクエストには、いずれかの承認済みサービス アカウント用に Google によって署名された OAuth トークンを含む HTTP 認証ヘッダーが必要です。

       トークンタイプの詳細を確認する。

     省略可: 次のいずれかのキーを設定できます。

     • output_payload_format_avro_schema_definition
     • output_payload_format_json

     • output_payload_format_protobuf_schema_definition

       出力形式を設定する場合は、入力形式も指定する必要があります（次の input-payload-format-* フラグをご覧ください）。

     省略可: http_endpoint_uri が宛先キーとして使用されていない場合は、次のキーを設定できます。

     • project - 宛先リソースの Google Cloud プロジェクト ID。デフォルトでは、パイプラインのプロジェクト ID が使用されます。
     • location - 宛先リソースのロケーション。デフォルトでは、パイプラインのロケーションが使用されます。

   • LOCATION: Eventarc Advanced でサポートされているリージョン

     または、gcloud CLI のロケーション プロパティを設定することもできます。

     gcloud config set eventarc/location LOCATION
     

   省略可: 次のフラグを使用できます。

   • --async: 処理中のオペレーションの完了を待たずに、コマンドからすぐに戻ります。
   • --crypto-key: 顧客管理の暗号鍵の完全修飾名を指定します。指定しない場合は、 Google-owned and managed keys が使用されます。
   • --logging-config: ロギングレベルを構成します。次のいずれかの値を指定する必要があります。NONE、DEBUG、INFO、NOTICE、WARNING、ERROR、CRITICAL、ALERT、EMERGENCY。

   • --mediations: 変換を適用します。transformation_template はサポートされている唯一のテンプレートであり、パイプラインごとに 1 つのメディエーションのみがサポートされています。例:

     --mediations=transformation_template='message.removeFields(["id\ ","credit_card_number","age"])'

     変換を適用する場合は、次のいずれかのフラグを使用して入力形式を指定する必要があります。

   • 入力形式を指定する次のいずれか。

     • --input-payload-format-avro-schema-definition
     • --input-payload-format-json
     • --input-payload-format-protobuf-schema-definition

   • --max-retry-attempts、--max-retry-delay、--min-retry-delay を再試行イベントに

   次に例を示します。

   gcloud beta eventarc pipelines create my-pipeline \
       --destinations=http_endpoint_uri='https://example-endpoint.com',network_attachment=my-network-attachment,oauth_token_authentication_service_account=example-service-account@example-project.gserviceaccount.iam.com,oauth_token_authentication_scope='https://www.googleapis.com/auth/cloud-platform',output_payload_format_avro_schema_definition='{"type": "record","name": "my_record", "fields": [{"name": "my_field", "type":"string"}]}' \
       --input-payload-format-avro-schema-definition='{"type":"record", "name": "my_record", "fields": [{"name": "my_field","type": "string"}]}' \
       --location=us-central1 \
       --async
   

   詳細と例については、gcloud CLI のドキュメントをご覧ください。

登録

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

2. gcloud beta eventarc enrollments create コマンドを使用して登録を作成します。

   gcloud beta eventarc enrollments create ENROLLMENT_NAME \
       --cel-match=MATCH_EXPRESSION \
       --destination-pipeline=PIPELINE_NAME \
       --message-bus=BUS_NAME \
       --message-bus-project=PROJECT_ID \
       --location=LOCATION

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

   • ENROLLMENT_NAME: 登録の ID または完全修飾名
   • MATCH_EXPRESSION: この登録の CEL を使用したマッチング式（例: "message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'"）
   • PIPELINE_NAME: この登録のターゲット パイプライン ID または完全修飾名
   • BUS_NAME: Eventarc Advanced バスの ID または完全修飾名
   • PROJECT_ID: バスの Google Cloud プロジェクト ID

   • LOCATION: Eventarc Advanced でサポートされているリージョン

     または、gcloud CLI のロケーション プロパティを設定することもできます。

     gcloud config set eventarc/location LOCATION
     

   省略可: 次のフラグを使用できます。

   • --async: 処理中のオペレーションの完了を待たずに、コマンドからすぐに戻ります。

   次に例を示します。

   gcloud beta eventarc enrollments create my-enrollment \
       --cel-match="message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'" \
       --destination-pipeline=my-pipeline \
       --message-bus=my-message-bus \
       --message-bus-project=another-google-cloud-project \
       --location=us-central1 \
       --async
   

パイプライン

パイプラインを作成するには、projects.locations.pipelines.create メソッドを使用します。

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

• name: パイプラインの完全なリソース名（projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME 形式）。

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

  • PROJECT_ID: パイプライン プロジェクトの Google Cloudプロジェクト ID
  • LOCATION: パイプラインがデプロイされるリージョン（例: us-central1）
  • PIPELINE_NAME: パイプラインの名前
• LABEL_KEY、LABEL_VALUE: 省略可。 Google Cloud リソースの整理に役立つラベルの Key-Value ペアのマップです。詳細については、ラベルとはをご覧ください。
• ANNOTATION_KEY、ANNOTATION_VALUE: 省略可。自由形式のテキストのアノテーション キーと値のペアのマップ。これらを使用して、リソースに関連付けられた任意の情報を付加できます。詳細については、アノテーションをご覧ください。
• LOG_SEVERITY: 省略可。ログエントリに記述されているイベントの最小重大度。NONE、DEBUG、INFO、NOTICE、WARNING、ERROR、CRITICAL、ALERT、EMERGENCY のいずれか。デフォルトは NONE です。詳細については、LogSeverity をご覧ください。
• destinations: メッセージの転送先。サポートされている宛先は 1 つのみです（httpEndpoint、messageBus、topic、workflow）。詳細については、Destination ターゲットをご覧ください。たとえば、次のように置き換えます。
  • HTTP_URI: 宛先 URI。ホストは、Virtual Private Cloud（VPC）ネットワークからアドレス指定可能な静的 IP アドレスか、Cloud DNS を使用して解決可能なサービスの内部 ドメイン ネーム システム（DNS）ホスト名のいずれかです。必要に応じて、messageBindingTemplate を設定して メッセージ バインディングを指定することもできます。
  • networkAttachment: httpEndpoint（Cloud Run URL を含む）にのみ適用されます。ネットワーク アタッチメントの完全なリソース名。形式は projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION /networkAttachments/NETWORK_ATTACHMENT_NAME です。ネットワーク アタッチメントは、プロデューサーの Virtual Private Cloud ネットワークがコンシューマー VPC ネットワークへの接続を開始できるようにするリソースであり、指定する必要があります。イベントを公開するために、Eventarc Advanced はネットワーク アタッチメントを使用して、VPC ネットワークでホストされているエンドポイントとの接続を確立します。

    ネットワーク アタッチメントを参照する Private Service Connect インターフェースからの接続を自動的に受け入れるネットワーク アタッチメントを作成できます。宛先リソースを含むネットワークとリージョンにネットワーク アタッチメントを作成します。

    DNS アドレス（Cloud Run など）を使用してメッセージを Google の宛先に転送する場合は、ネットワーク アタッチメントで使用されるサブネットで限定公開の Google アクセスが有効になっていることを確認してください。そうしないと、DNS アドレスを解決できません。

  • SERVICE_ACCOUNT_EMAIL: OIDC トークンの生成に使用されるサービス アカウントのメールアドレスの名前。このトークンは、トークンを自分で検証するエンドポイントなど、多くのシナリオで使用できます。必要に応じて、audience を設定して、このトークンの対象となるオーディエンスを指定できます。通常は、ターゲット パイプラインの URL と一致する必要があります。指定しない場合、リクエスト パラメータを含む URL 全体が使用されます。

    または、oauthToken を使用して、OAuth トークンの生成に使用するサービス アカウントのメールアドレスを指定することもできます。これは通常、*.googleapis.com でホストされている Google API を呼び出す場合にのみ使用します。必要に応じて、scope を設定してこのトークンのスコープを指定できます。指定しない場合、デフォルトは https://www.googleapis.com/auth/cloud-platform になります。 Google Cloudサービスの場合は、すべての Google Cloud API を含む https://www.googleapis.com/auth/cloud-platform スコープとともに、きめ細かなアクセス制御を行える Identity and Access Management（IAM）を使用することをおすすめします。

    別の Eventarc Advanced バス、Pub/Sub、Workflows へのすべてのリクエストには、いずれかの承認済みサービス アカウント用に Google によって署名された OAuth トークンを含む HTTP 認証ヘッダーが必要です。

    トークンタイプの詳細を確認する。

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

{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},"networkConfig":
  {"networkAttachment": "projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION/networkAttachments/NETWORK_ATTACHMENT_NAME"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}

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

cat > request.json << 'EOF'
{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},"networkConfig":
  {"networkAttachment": "projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION/networkAttachments/NETWORK_ATTACHMENT_NAME"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}
EOF

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

@'
{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},"networkConfig":
  {"networkAttachment": "projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION/networkAttachments/NETWORK_ATTACHMENT_NAME"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}
'@  | Out-File -FilePath request.json -Encoding utf8

$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://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelines?pipeline_id=PIPELINE_NAME" | Select-Object -Expand Content

成功した場合、レスポンスの本文には、新しく作成された Operation のインスタンスが含まれます。

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.eventarc.v1.OperationMetadata",
    "createTime": "2024-01-25T17:17:45.782370139Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

登録

登録を作成するには、projects.locations.enrollments.create メソッドを使用します。

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

• ENROLLMENT_NAME: 登録の表示名（例: my_enrollment）。
• MATCH_EXPRESSION: この登録が適用されるメッセージを識別する CEL 式。例: message.type == 'hello-world-type'
• destination: ターゲット パイプラインの完全なリソース名（projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME 形式）。

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

  • PROJECT_ID: パイプライン プロジェクトの Google Cloudプロジェクト ID
  • LOCATION: パイプラインがデプロイされているリージョン（例: us-central1）。
  • PIPELINE_NAME: パイプラインの名前
• message_bus: メッセージの送信元を識別するバスの完全なリソース名（projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME の形式）。

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

  • BUS_PROJECT_ID: バス プロジェクトの Google Cloud プロジェクト ID
  • BUS_LOCATION: バスがデプロイされているリージョン（例: us-central1）
  • BUS_NAME: メッセージ バスの名前

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

{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}

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

cat > request.json << 'EOF'
{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}
EOF

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

@'
{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}
'@  | Out-File -FilePath request.json -Encoding utf8

$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://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/enrollments?enrollment_id=ENROLLMENT_NAME" | Select-Object -Expand Content

成功した場合、レスポンスの本文には、新しく作成された Operation のインスタンスが含まれます。

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.eventarc.v1.OperationMetadata",
    "createTime": "2024-01-25T17:17:45.782370139Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/enrollments/ENROLLMENT_NAME",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}