用於設定發布至 Pub/Sub 的通知。系統會使用下列 PubsubMessage.attributes
將通知發布至客戶提供的主題:
"eventType"
:EventType
值之一"payloadFormat"
:PayloadFormat
值之一"projectId"
:TransferOperation
的projectId
"transferJobName"
:TransferOperation
的transferJobName
"transferOperationName"
:TransferOperation
的name
PubsubMessage.data
包含 TransferOperation
資源,其格式會根據指定的 PayloadFormat
格式化。
JSON 表示法 |
---|
{ "pubsubTopic": string, "eventTypes": [ enum ( |
欄位 | |
---|---|
pubsubTopic |
這是必要旗標,要發布通知的 Pub/Sub 主題的 |
eventTypes[] |
需要通知的事件類型。如果留空,則會針對所有事件類型傳送通知。 |
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 中。 |