NotificationConfig

Pub/Sub にパブリッシュされる通知を構成するための仕様。通知は、次の PubsubMessage.attributes を使用して、お客様が指定したトピックにパブリッシュされます。

PubsubMessage.data には、指定された PayloadFormat に従ってフォーマットされた TransferOperation リソースが含まれています。

JSON 表現 
{
  "pubsubTopic": string,
  "eventTypes": [
    enum (EventType)
  ],
  "payloadFormat": enum (PayloadFormat)
}
フィールド
pubsubTopic

string

必須。通知をパブリッシュする Pub/Sub トピックの Topic.name。形式は projects/{project}/topics/{topic} にする必要があります。この形式と一致しないと、INVALID_ARGUMENT エラーが発生します。
eventTypes[]

enum (EventType)

通知を受け取るイベントの種類。空の場合は、すべてのイベントタイプに対して通知を送信します。
payloadFormat

enum (PayloadFormat)

必須。通知メッセージ ペイロードの形式。

EventType

通知を公開するイベントタイプを指定する列挙型。

今後、イベントの種類が追加される可能性があります。クライアントは、認識できない種類のイベントを無視するか、受信可能な種類のイベントを明示的に指定する必要があります。

列挙型
EVENT_TYPE_UNSPECIFIED デフォルトを許可しないように、不正な値。
TRANSFER_OPERATION_SUCCESS TransferOperation がステータス SUCCESS で完了しました。
TRANSFER_OPERATION_FAILED TransferOperation がステータス FAILED で完了しました。
TRANSFER_OPERATION_ABORTED TransferOperation がステータス ABORTED で完了しました。

PayloadFormat

通知メッセージのペイロードの形式を指定する列挙型。

列挙型
PAYLOAD_FORMAT_UNSPECIFIED デフォルトを許可しないように、不正な値。
NONE 通知にペイロードを追加しません。
JSON TransferOperation は、application/json の JSON レスポンスとしてフォーマットされます。