Method: projects.locations.clusters.watchEvents

Achte auf Aktualisierungen zu Ereignissen in den entsprechenden Streams.

HTTP-Anfrage

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

Dabei ist {endpoint} einer der unterstützten Dienstendpunkte.

Die URLs verwenden die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
cluster

string

Das übergeordnete Element der Ressource.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "watcherId": string,
  "streams": [
    string
  ],
  "eventUpdateFilter": {
    object (EventUpdateFilter)
  },
  "heartbeatIntervalSecond": number
}
Felder
watcherId

string

Die eindeutige ID identifiziert den Zuschauer der Streams.
streams[]

string

Der Name des Streams oder der Streams, die angesehen werden sollen.
eventUpdateFilter

object (EventUpdateFilter)

Der Filter, mit dem die Beobachter angeben können, welche Ereignisaktualisierungen sie erhalten möchten.
heartbeatIntervalSecond

number

Mit HeartbeatIntervalSecond wird das Intervall (in Sekunden) der Heartbeat-Antwort definiert, die vom gRPC-Streamingserver zurückgegeben wird. Der Standardwert „0“ bedeutet, dass kein Heartbeat zurückgegeben wird.

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Jede Antwortnachricht enthält ein Ereignisupdate.

JSON-Darstellung 
{
  "updateType": enum (EventUpdateType),
  "stream": string,
  "event": string,
  "series": string,
  "updateTime": string
}
Felder
updateType

enum (EventUpdateType)

Der Typ der Ereignisaktualisierung.
stream

string

Der Name des Streams, mit dem das Ereignis verknüpft ist.
event

string

Der Name des Ereignisses.
series

string

Der Name der Reihe.
updateTime

string (Timestamp format)

Der Zeitstempel, zu dem die Ereignisaktualisierung erfolgt.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource cluster:

  • visionai.clusters.watch

Weitere Informationen finden Sie in der IAM-Dokumentation.

EventUpdateFilter

Mit dem Filter „EventUpdateFilter“ können Beobachter angeben, welche Ereignisaktualisierungen sie erhalten möchten.

JSON-Darstellung 
{

  // 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.
}
Felder

Union-Feld start_time.

Für start_time ist nur einer der folgenden Werte zulässig:
specialMode

enum (SpecialMode)

Spezielle Modi, die nicht auf einen bestimmten Zeitstempel zurückzuführen sind.
specificTime

string (Timestamp format)

Bestimmter Zeitstempel, nach dem die Ereignisaktualisierungen erfolgen.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

SpecialMode

Spezielle Modi, die nicht auf einen bestimmten Zeitstempel zurückzuführen sind.

Enums
SPECIAL_MODE_UNSPECIFIED Sondermodus nicht angegeben.
BEGINNING Der spezielle Modus „BEGINNING“ bezieht sich auf alle derzeit verfügbaren Ereignisse und eingehenden Ereignisaktualisierungen.
LATEST Im speziellen Modus „LATEST“ werden nur die neuesten Ereignisse und eingehenden Ereignisaktualisierungen angezeigt.

EventUpdateType

Der Typ der Ereignisaktualisierungen. Kann in Zukunft auf andere Anwendungsfälle erweitert werden, z. B. EVENT_DETACHED_FROM_STREAM.

Enums
EVENT_UPDATE_TYPE_UNSPECIFIED Ereignisaktualisierungstyp nicht angegeben.
EVENT_AVAILABLE_ON_STREAM Das Ereignis kann aus einem Stream gelesen werden.
EVENT_HEARTBEAT Heartbeat-Nachricht, mit der die Aktivität der gRPC-Verbindung erfasst wird.