Pub/Sub ステータス通知を送信するジョブを作成して実行する

このドキュメントでは、Pub/Sub 通知を送信する Batch ジョブを作成する方法について説明します。Pub/Sub を使用すると、ジョブまたはタスクの状態が変化したとき、またはジョブまたはタスクが特定の状態になったときに通知を受け取ることができます。詳細については、 通知を使用してジョブをモニタリングするをご覧ください。

準備

1. Batch を以前に使用したことがない場合は、Batch を使ってみるを確認し、プロジェクトとユーザーの前提条件を完了して Batch を有効にします。
2. Batch 通知用の Pub/Sub トピックを作成または識別します。
3. 通知を受信して使用するためのサブスクリプションを構成する。

必要なロール

• 通知を送信するジョブを作成して実行するために必要な権限を取得するには、管理者に次の IAM ロールを付与するよう依頼してください。

  • Batch ジョブ編集者 （roles/batch.jobsEditor） プロジェクト
  • サービス アカウント ユーザー （roles/iam.serviceAccountUser） ジョブのサービス アカウントの。デフォルトではCompute Engine のデフォルトのサービス アカウントです。
  • Pub/Sub トピックまたはプロジェクトに対する Pub/Sub 編集者（roles/pubsub.editor）。

  ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

  必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

• ジョブのサービス アカウントにデフォルト構成を使用していない場合は、必要な権限があることを確認してください。

  ジョブのサービス アカウントに Pub/Sub 通知を公開するために必要な 権限があることを確認するには、 Pub/Sub トピックに対する Pub/Sub パブリッシャー （roles/pubsub.publisher）IAM ロールをジョブのサービス アカウントに付与するよう管理者に依頼します。

• ジョブがジョブとは異なるプロジェクトにある Pub/Sub トピックに通知を公開する場合は、ジョブのプロジェクトのBatch サービス エージェントに、そのトピックに公開する権限を付与する必要があります。

  ジョブのプロジェクトの Batch サービス エージェントに、別のプロジェクトの Pub/Sub トピックに Pub/Sub 通知を公開するために必要な 権限を付与するには、 ジョブのプロジェクトの Batch サービス エージェントに Pub/Sub トピックに対する Pub/Sub パブリッシャー （roles/pubsub.publisher）IAM ロールを付与するよう管理者に依頼します。

通知を送信するジョブを作成して実行する

次の操作を行うと、Pub/Sub 通知を送信する Batch ジョブを作成できます。

{
...
  "notifications": [
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
      "message": {
        ATTRIBUTES
      }
    }
  ]
...
}

{
  "taskGroups": [
    {
      "taskSpec": {
        "runnables": [
          {
            "script": {
              "text": "echo Hello World! This is task $BATCH_TASK_INDEX."
            }
          }
        ]
      },
      "taskCount": 3,
    }
  ],
  "logsPolicy": {
      "destination": "CLOUD_LOGGING"
  },
  "notifications": [
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
      "message": {
        "type": "JOB_STATE_CHANGED"
      }
    },
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
      "message": {
        "type": "TASK_STATE_CHANGED",
        "newTaskState": "FAILED"
      }
    }
  ]
}

{
...
  "notifications": [
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
      "message": {
        ATTRIBUTES
      }
    }
  ]
...
}

{
  "taskGroups": [
    {
      "taskSpec": {
        "runnables": [
          {
            "script": {
              "text": "echo Hello World! This is task $BATCH_TASK_INDEX."
            }
          }
        ]
      },
      "taskCount": 3,
    }
  ],
  "logsPolicy": {
      "destination": "CLOUD_LOGGING"
  },
  "notifications": [
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
      "message": {
        "type": "JOB_STATE_CHANGED"
      }
    },
    {
      "pubsubTopic": "projects/PROJECT_ID/topics/TOPIC_ID",
      "message": {
        "type": "TASK_STATE_CHANGED",
        "newTaskState": "FAILED"
      }
    }
  ]
}