Method: projects.locations.clusters.watchEvents

Surveillez les informations sur les événements qui se produisent sur les flux donnés.

Requête HTTP

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

Où {endpoint} est l'un des points de terminaison de service compatibles.

Les URL utilisent la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
cluster

string

Parent de la ressource.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "watcherId": string,
  "streams": [
    string
  ],
  "eventUpdateFilter": {
    object (EventUpdateFilter)
  },
  "heartbeatIntervalSecond": number
}
Champs
watcherId

string

L'ID unique identifie le spectateur des flux.
streams[]

string

Nom du flux ou de l'ensemble de flux à regarder.
eventUpdateFilter

object (EventUpdateFilter)

Filtre que les observateurs peuvent spécifier pour les mises à jour d'événements qu'ils souhaitent recevoir.
heartbeatIntervalSecond

number

HeartbeatIntervalSecond définit l'intervalle (en secondes) de la réponse de battement de cœur renvoyée par le serveur de streaming gRPC. La valeur par défaut est 0, ce qui signifie qu'aucun "heartbeat" n'est renvoyé.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Chaque message de réponse contient une mise à jour d'événement.

Représentation JSON 
{
  "updateType": enum (EventUpdateType),
  "stream": string,
  "event": string,
  "series": string,
  "updateTime": string
}
Champs
updateType

enum (EventUpdateType)

Type de mise à jour de l'événement.
stream

string

Nom du flux auquel l'événement est associé.
event

string

Nom de l'événement.
series

string

Nom de la série.
updateTime

string (Timestamp format)

Code temporel de la mise à jour de l'événement.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Champs d'application des autorisations

Requiert le champ d'application OAuth suivant :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource cluster :

  • visionai.clusters.watch

Pour en savoir plus, consultez la documentation IAM.

EventUpdateFilter

EventUpdateFilter est le filtre que les observateurs peuvent utiliser pour spécifier les mises à jour d'événements qu'ils souhaitent recevoir.

Représentation 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.
}
Champs

Champ d'union start_time.

start_time ne peut être qu'un des éléments suivants :
specialMode

enum (SpecialMode)

Modes spéciaux autres qu'un code temporel spécifique
specificTime

string (Timestamp format)

Code temporel spécifique après lequel les mises à jour d'événements se produisent.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

SpecialMode

Modes spéciaux autres qu'un code temporel spécifique

Enums
SPECIAL_MODE_UNSPECIFIED Mode spécial non spécifié.
BEGINNING Le mode spécial BEGINNING signifie que tous les événements actuellement disponibles et les mises à jour d'événements entrantes sont inclus.
LATEST Le mode spécial "LATEST" (DERNIERS) n'affiche que les derniers événements et les mises à jour des événements entrants.

EventUpdateType

Type des mises à jour d'événement. Peut être étendu à d'autres cas d'utilisation à l'avenir (par exemple, EVENT_DETACHED_FROM_STREAM, etc.).

Enums
EVENT_UPDATE_TYPE_UNSPECIFIED Type de mise à jour de l'événement non spécifié.
EVENT_AVAILABLE_ON_STREAM L'événement peut être lu à partir d'un flux.
EVENT_HEARTBEAT Message de pulsation utilisé pour suivre l'activité de la connexion gRPC.