本文說明如何提交 Pub/Sub 主題的結構定義修訂版本。
事前準備
- 瞭解 Pub/Sub 結構定義的運作方式。
- 建立結構定義。
必要角色和權限
如要取得提交結構定義修訂版本和管理結構定義所需的權限,請要求管理員為您授予專案的 Pub/Sub 編輯者 (roles/pubsub.editor
) 身分與存取權管理角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。
這個預先定義的角色包含提交結構定義修訂版本和管理結構定義所需的權限。如要查看確切的必要權限,請展開「必要權限」部分:
所需權限
如要提交結構定義修訂版本及管理結構定義,必須具備下列權限:
-
建立結構定義:
pubsub.schemas.create
-
將結構定義附加至主題:
pubsub.schemas.attach
-
提交結構定義修訂版本:
pubsub.schemas.commit
-
刪除結構定義或結構定義修訂版本:
pubsub.schemas.delete
-
取得結構定義或結構定義修訂版本:
pubsub.schemas.get
-
清單結構定義:
pubsub.schemas.list
-
列出結構定義修訂版本:
pubsub.schemas.listRevisions
-
回退結構定義:
pubsub.schemas.rollback
-
驗證訊息:
pubsub.schemas.validate
-
取得結構定義的身分與存取權管理政策:
pubsub.schemas.getIamPolicy
-
設定結構定義的 IAM 政策:
pubsub.schemas.setIamPolicy
您可以將角色和權限授予主體,例如使用者、群組、網域或服務帳戶。您可以在一個專案中建立結構定義,並將其附加至位於其他專案的主題。請確認您具備每個專案的必要權限。
修改結構定義
您可以使用Google Cloud 控制台、gcloud CLI、Pub/Sub API 或 Cloud 用戶端程式庫,提交結構定義修訂版本。
以下是提交結構定義修訂版本的幾項準則:
您可以在特定限制內修改結構定義:
您可以新增或移除 Protocol Buffer 結構定義中的選填欄位。您無法新增或刪除其他欄位。也無法編輯任何現有欄位。
如要瞭解 Avro 結構定義,請參閱 Avro 說明文件,瞭解結構定義解���的規則。新修訂版本必須遵循讀取器結構定義和寫入器結構定義的規則。
一次最多可修訂 20 個結構定義。如果超過上限,請先刪除一個結構定義修訂版本,再建立其他版本。
每個修訂版本都會附上專屬的修訂版本 ID。修訂版本 ID 是系統自動產生的八個字元 UUID。
更新用於主題驗證的修訂範圍或結構定義修訂版本時,變更可能需要幾分鐘才會生效。
控制台
如要建立結構定義修訂版本,請按照下列步驟操作:
在 Google Cloud 控制台中,前往「Pub/Sub 結構定義」頁面。
按一下現有結構定義的「結構定義 ID」。
結構定義的「Schema details」(結構定義詳細資料) 頁面隨即開啟。
按一下「建立修訂版本」。
「Create schema revision」頁面隨即開啟。
視需要進行變更。
舉例來說,針對您在「建立結構定義」中建立的 Avro 範例結構定義,您可以新增額外的選用欄位
Price
,如下所示:{ "type": "record", "name": "Avro", "fields": [ { "name": "ProductName", "type": "string", "default": "" }, { "name": "SKU", "type": "int", "default": 0 }, { "name": "InStock", "type": "boolean", "default": false }, { "name": "Price", "type": "double", "default": "0.0" } ] }
按一下「驗證定義」,檢查結構定義是否正確。
您也可以驗證結構定義的訊息。
按一下「測試訊息」,測試範例訊息。
在「Test message」視窗中,選取「Message encoding」類型。
在「郵件內文」中輸入測試訊息。
舉例來說,以下是測試結構定義的範例訊息。在本範例中,請選取「訊息編碼」為
JSON
。{"ProductName":"GreenOnions", "SKU":34543, "Price":12, "InStock":true}
按一下「Test」。
按一下「提交」,即可儲存結構定義。
gcloud
gcloud pubsub schemas commit SCHEMA_ID \ --type=SCHEMA_TYPE \ --definition=SCHEMA_DEFINITION
其中:
- SCHEMA_TYPE 可以是
avro
或protocol-buffer
。 - SCHEMA_DEFINITION 是
string
,其中包含結構定義,並根據所選的結構類型設定格式。
您也可以在檔案中指定結構定義:
gcloud pubsub schemas commit SCHEMA_ID \ --type=SCHEMA_TYPE \ --definition-file=SCHEMA_DEFINITION_FILE
其中:
- SCHEMA_TYPE 可以是
avro
或protocol-buffer
。 - SCHEMA_DEFINITION_FILE 是
string
,其中包含結構定義檔案的路徑,並根據所選的結構類型設定格式。
REST
如要提交結構定義修訂版本,請傳送以下 POST 要求:
POST https://pubsub.googleapis.com/v1/projects/PROJECT_ID/schemas/SCHEMA_ID:commit Authorization: Bearer $(gcloud auth application-default print-access-token) Content-Type: application/json --data @response-body.json
指定以下要求主體欄位:
{ "definition": SCHEMA_DEFINITION "type": SCHEMA_TYPE "name": SCHEMA_NAME }
其中:
- SCHEMA_TYPE 可以是
AVRO
或PROTOCOL_BUFFER
。 - SCHEMA_DEFINITION 是包含結構定義的字串,格式會根據所選的結構類型而定。
- SCHEMA_NAME 是現有結構定義的名稱。
回應主體應包含結構定義資源的 JSON 表示法。例如:
{ "name": SCHEMA_NAME, "type": SCHEMA_TYPE, "definition": SCHEMA_DEFINITION "revisionId": REVISION_ID "revisionCreateTime": REVISION_CREATE_TIME }
其中:
- REVISION_ID 是伺服器為修訂版本產生的 ID。
- REVISION_CREATE_TIME 是修訂版本建立時的 ISO 8601 時間戳記。
Go
在試用這個範例之前,請先按照 快速入門:使用用戶端程式庫中的 Go 設定說明進行操作。詳情請參閱 Pub/Sub Go API 參考說明文件。
Avro
Proto
C++
在嘗試這個範例之前,請先按照 快速入門:使用用戶端程式庫中的操作說明設定 C++ 環境。詳情請參閱 Pub/Sub C++ API 參考說明文件。
Avro
Proto
Java
在嘗試這個範例之前,請先按照 快速入門:使用用戶端程式庫中的操作說明設定 Java 環境。詳情請參閱 Pub/Sub Java API 參考說明文件。
Avro
Proto
Python
在嘗試這個範例之前,請先按��� 快速入門:使用用戶端程式庫中的操作說明設定 Python 環境。詳情請參閱 Pub/Sub Python API 參考說明文件。
Avro
Proto
Node.js
在嘗試這個範例之前,請先按照 快速入門:使用用戶端程式庫中的操作說明設定 Node.js 環境。詳情請參閱 Pub/Sub Node.js API 參考說明文件。
Avro
Proto
Node.js
在嘗試這個範例之前,請先按照 快速入門:使用用戶端程式庫中的操作說明設定 Node.js 環境。詳情請參閱 Pub/Sub Node.js API 參考說明文件。
Avro
Proto
提交結構定義修訂版本後,您可以在「結構定義」頁面中查看新修訂版本的詳細資料。