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 的格式为 JSON 响应,采用 application/json 格式。