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 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："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

如需了解详情，请参阅 IAM 文档。

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 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

SpecialMode

除特定时间戳之外的特殊模式。

枚举
SPECIAL_MODE_UNSPECIFIED 未指定特殊模式。
BEGINNING “BEGINNING special mode”表示所有当前可用的事件和传入的事件更新。
LATEST “最新”特殊模式表示仅显示最新事件和即将到来的事件更新。

EventUpdateType

事件更新的类型。未来可扩展为适用于其他用例，例如 EVENT_DETACHED_FROM_STREAM 等。

枚举
EVENT_UPDATE_TYPE_UNSPECIFIED 未指定事件更新类型。
EVENT_AVAILABLE_ON_STREAM 事件可从流中读取。
EVENT_HEARTBEAT 用于跟踪 gRPC 连接活跃性的心跳消息。