Method: projects.locations.clusters.watchEvents

指定したライブ配信で発生したイベントの最新情報を確認する。

HTTP リクエスト

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

ここで、{endpoint} はサポートされているサービス エンドポイントのいずれかです。

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 は、ハートビートなしを意味します。

レスポンスの本文

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

各レスポンス メッセージには、1 件のイベントの更新が含まれます。

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「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "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「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

SpecialMode

特定のタイムスタンプ以外の特別なモード。

列挙型
SPECIAL_MODE_UNSPECIFIED 特殊モードが指定されていません。
BEGINNING 開始時の特別モードとは、現在利用可能なすべてのイベントと、受信するイベントの更新を意味します。
LATEST LATEST スペシャル モードは、最新のイベントと受信したイベントの最新情報のみを表示します。

EventUpdateType

イベントの更新のタイプ。将来、他のユースケース（EVENT_DETACHED_FROM_STREAM など）に拡張できます。

列挙型
EVENT_UPDATE_TYPE_UNSPECIFIED イベントの更新タイプが指定されていません。
EVENT_AVAILABLE_ON_STREAM イベントはストリームから読み取ることができます。
EVENT_HEARTBEAT gRPC 接続の存続を確認するために使用されるハートビート メッセージ。