BigQuery Data Transfer Service の実行通知

このページでは、BigQuery Data Transfer Service の実行通知の概要について説明します。

は、

概要

BigQuery Data Transfer Service で構成できる実行通知には、次の 2 つの種類があります。

  • Cloud Pub/Sub 通知 - 転送実行が成功または失敗したときに送信される、機械が読み取り可能な通知
  • メール通知 - 転送実行が失敗したときに送信される、人が読める通知

それぞれの種類を個別に構成することも、Cloud Pub/Sub とメールの両方の実行通知を使用することもできます。

Cloud Pub/Sub の通知

Cloud Pub/Sub の通知では、転送実行に関する情報が Cloud Pub/Sub トピックに送信されます。次の状態の完了した転送実行によって、Cloud Pub/Sub 通知がトリガーされます。

  • SUCCEEDED
  • FAILED
  • CANCELLED

通知は、必要な権限のある任意のプロジェクトの任意の Cloud Pub/Sub トピックに送信できます。Cloud Pub/Sub トピックが通知を受信すると、メッセージがトピックのサブスクライバーに送信されます。

始める前に

Cloud Pub/Sub の転送実行通知を構成する前に、以下を行う必要があります。

  1. 通知を受け取るプロジェクトの Cloud Pub/Sub API を有効にすること。

    API を有効にする

  2. 通知を受け取るプロジェクトに対して十分な権限を持っていること。

    • 通知を受け取るプロジェクトを所有している場合は、必要な権限を持っていると考えられます。

    • 通知を受け取るトピックを作成する場合は、pubsub.topics.create 権限が必要です。

    • 新規トピックまたは既存トピックを使用する予定がある場合は、pubsub.topics.setIamPolicy 権限が必要です。トピックを作成する場合、通常は pubsub.topics.setIamPolicy 権限を持っています。次の事前定義されたプロジェクト レベルの IAM 役割には、pubsub.topics.setIamPolicy 権限が付与されています。

      • pubsub.admin の事前定義された役割
      • Owner の基本の役割

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

  3. 通知を送信する既存の Cloud Pub/Sub トピックを持っていること。

通知形式

Cloud Pub/Sub トピックに送信される通知は、次の 2 つの部分から構成されます。

  • 属性: イベントを記述するキー値のペアのセット
  • ペイロード: 変更されたオブジェクトのメタデータを含む文字列

属性

属性は、BigQuery Data Transfer Service から Cloud Pub/Sub トピックに送信されるすべての通知に含まれる Key-Value ペアです。ペイロードに関係なく、通知には次の Key-Value ペアが必ず含まれます。

属性名 説明
eventType TRANSFER_RUN_FINISHED 発生したイベントの種類。TRANSFER_RUN_FINISHED が唯一の有効な値です。
payloadFormat JSON_API_V1 オブジェクトのペイロードの形式。JSON_API_V1 が唯一の有効な値です。

ペイロード

ペイロードは、転送実行のメタデータを含む文字列です。ペイロードの種類は現時点では構成できず、将来の API バージョンの変更に備えて用意されています。

ペイロードの種類 説明
JSON_API_V1 ペイロードは、TransferRun のリソース表現を含む UTF-8 のシリアル化された JSON 形式の文字列になります。

メール通知

メール通知では、転送実行が失敗したときに人が読めるメール メッセージが送信されます。これらのメッセージは、転送を設定したユーザーに送信されます。メッセージは構成できません

他のユーザーが転送実行のメール通知を受信する必要がある場合は、メッセージを配信するメール転送ルールを設定します。Gmail を使用している場合は、自動的に Gmail メッセージを別のアカウントに転送できます。

メール通知は BigQuery Data Transfer Service から送信されます。メール通知には、転送構成と転送実行の詳細と、失敗した実行の実行履歴へのリンクが含まれています。次に例を示します。

From: bigquery-data-transfer-service-noreply@google.com
To: [USER_WHO_SET_UP_TRANSFER]
Title: BigQuery Data Transfer Service - Transfer Run Failure - [DISPLAY_NAME]

Transfer Configuration
Display Name: [DISPLAY_NAME]
Source: [DATA_SOURCE]
Destination: [PROJECT_ID]

Run Summary
Run: [RUN_NAME]
Schedule Time: [SCHEDULE_TIME]
Run Time: [RUN_TIME]
View Run History

Google LLC 1600 Amphitheatre Parkway, Mountain View, CA 94043

This email was sent because you indicated you are willing to receive Run
Notifications from the BigQuery Data Transfer Service. If you do not wish to
receive such emails in the future, click View Transfer Configuration and
un-check the “Send E-mail Notifications” option.

実行通知の料金

アルファ版の BigQuery Data Transfer Service では、実行通知に対しては課金されません。Cloud Pub/Sub の実行通知を構成すると、Cloud Pub/Sub の料金が発生します。詳細については、Cloud Pub/Sub の料金をご覧ください。

次のステップ

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

ご不明な点がありましたら、Google のサポートページをご覧ください。