Method: projects.locations.clusters.watchEvents

Mengamati pembaruan peristiwa yang terjadi di aliran data tertentu.

Permintaan HTTP

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

Dengan {endpoint} adalah salah satu endpoint layanan yang didukung.

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
cluster

string

Induk resource.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "watcherId": string,
  "streams": [
    string
  ],
  "eventUpdateFilter": {
    object (EventUpdateFilter)
  },
  "heartbeatIntervalSecond": number
}
Kolom
watcherId

string

ID unik mengidentifikasi pemantau streaming.

streams[]

string

Nama streaming atau kumpulan streaming yang akan ditonton.

eventUpdateFilter

object (EventUpdateFilter)

Filter yang dapat ditentukan oleh pengamat tentang pembaruan peristiwa yang ingin mereka terima.

heartbeatIntervalSecond

number

HeartbeatIntervalSecond menentukan interval (dalam detik) respons heartbeat yang ditampilkan dari server streaming gRPC. Default 0 berarti tidak ada heartbeat yang akan ditampilkan.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Setiap pesan respons akan berisi satu pembaruan Peristiwa.

Representasi JSON
{
  "updateType": enum (EventUpdateType),
  "stream": string,
  "event": string,
  "series": string,
  "updateTime": string
}
Kolom
updateType

enum (EventUpdateType)

Jenis pembaruan Peristiwa.

stream

string

Nama aliran data tempat peristiwa dilampirkan.

event

string

Nama peristiwa.

series

string

Nama serial.

updateTime

string (Timestamp format)

Stempel waktu saat pembaruan Peristiwa terjadi.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

Izin IAM

Memerlukan izin IAM berikut pada resource cluster:

  • visionai.clusters.watch

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

EventUpdateFilter

EventUpdateFilter adalah filter yang dapat ditentukan oleh pengamat tentang pembaruan peristiwa yang ingin mereka terima.

Representasi 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.
}
Kolom

Kolom union start_time.

start_time hanya dapat berupa salah satu dari hal berikut:

specialMode

enum (SpecialMode)

Mode khusus selain stempel waktu tertentu.

specificTime

string (Timestamp format)

Stempel waktu spesifik setelah pembaruan peristiwa terjadi.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

SpecialMode

Mode khusus selain stempel waktu tertentu.

Enum
SPECIAL_MODE_UNSPECIFIED Mode khusus tidak ditentukan.
BEGINNING Mode khusus BEGINNING berarti semua peristiwa yang saat ini tersedia dan pembaruan peristiwa yang masuk.
LATEST Mode khusus LATEST berarti hanya peristiwa terbaru dan pembaruan peristiwa yang masuk.

EventUpdateType

Jenis pembaruan peristiwa. Dapat diperluas pada masa mendatang untuk kasus penggunaan lainnya. Misalnya, EVENT_DETACHED_FROM_STREAM, dan lainnya.

Enum
EVENT_UPDATE_TYPE_UNSPECIFIED Jenis pembaruan peristiwa tidak ditentukan.
EVENT_AVAILABLE_ON_STREAM Peristiwa tersedia untuk dibaca dari streaming.
EVENT_HEARTBEAT Pesan heartbeat yang digunakan untuk melacak keaktifan koneksi gRPC.