Method: projects.locations.clusters.watchEvents

留意指定串流中發生的事件更新。

HTTP 要求

POST https://{endpoint}/v1/{cluster=projects/*/locations/*/clusters/*}:watchEvents

其中 {endpoint} 是支援的服務端點之一。

這些網址使用 gRPC 轉碼語法。

路徑參數

參數
cluster

string

資源的父項。

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "watcherId": string,
  "streams": [
    string
  ],
  "eventUpdateFilter": {
    object (EventUpdateFilter)
  },
  "heartbeatIntervalSecond": number
}
欄位
watcherId

string

用於識別串流觀眾的專屬 ID。
streams[]

string

要觀看的串流或串流組合名稱。
eventUpdateFilter

object (EventUpdateFilter)

觀察者可透過這個篩選器指定要接收哪些事件更新。
heartbeatIntervalSecond

number

HeartbeatIntervalSecond 會定義 gRPC 串流伺服器傳回心跳回應的間隔 (以秒為單位)。預設值 0 表示不會傳回心跳。

回應主體

如果成功，回應主體會含有以下結構的資料：

每則回應訊息都會包含一則事件更新。

JSON 表示法 
{
  "updateType": enum (EventUpdateType),
  "stream": string,
  "event": string,
  "series": string,
  "updateTime": string
}
欄位
updateType

enum (EventUpdateType)

事件更新的類型。
stream

string

事件所屬串流的名稱。
event

string

事件名稱。
series

string

系列名稱。
updateTime

string (Timestamp format)

事件更新發生的時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱驗證總覽一文。

IAM 權限

需要在 cluster 資源上具備下列 IAM 權限：

  • visionai.clusters.watch

詳情請參閱 身分與存取權管理說明文件。

EventUpdateFilter

EventUpdateFilter 是監控者可用來指定要接收哪些事件更新的篩選器。

JSON 表示法 
{

  // Union field start_time can be only one of the following:
  "specialMode": enum (SpecialMode),
  "specificTime": string
  // End of list of possible types for union field start_time.
}
欄位

聯集欄位 start_time。

start_time 只能是下列其中一項：
specialMode

enum (SpecialMode)

除了特定時間戳記以外的特殊模式。
specificTime

string (Timestamp format)

事件更新發生後的特定時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

SpecialMode

除了特定時間戳記以外的特殊模式。

列舉
SPECIAL_MODE_UNSPECIFIED 未指定特殊模式。
BEGINNING 特殊模式的 BEGINNING 表示所有目前可用的事件和即將到來的事件更新。
LATEST LATEST 特殊模式：只顯示最新事件和即將發生的事件更新。

EventUpdateType

事件更新的類型。日後可擴充至其他用途，例如 EVENT_DETACHED_FROM_STREAM 等。

列舉
EVENT_UPDATE_TYPE_UNSPECIFIED 未指定事件更新類型。
EVENT_AVAILABLE_ON_STREAM 可從串流中讀取事件。
EVENT_HEARTBEAT 用於追蹤 gRPC 連線是否運作的心跳訊息。