Method: projects.locations.clusters.watchEvents

Tieni d'occhio gli aggiornamenti sugli eventi che si verificano nei flussi in questione.

Richiesta HTTP

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

dove {endpoint} è uno degli endpoint di servizio supportati.

Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
cluster

string

La risorsa principale.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

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

string

L'ID univoco identifica chi guarda gli stream.
streams[]

string

Il nome dello stream o dell'insieme di stream da guardare.
eventUpdateFilter

object (EventUpdateFilter)

Il filtro che gli osservatori possono specificare per gli aggiornamenti sugli eventi che vogliono ricevere.
heartbeatIntervalSecond

number

HeartbeatIntervalSecond definisce l'intervallo (in secondi) della risposta heartbeat restituita dal server di streaming gRPC. Il valore predefinito 0 indica che non verrà restituito alcun heartbeat.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Ogni messaggio di risposta conterrà un aggiornamento evento.

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

enum (EventUpdateType)

Il tipo di aggiornamento evento.
stream

string

Il nome dello stream a cui è associato l'evento.
event

string

Il nome dell'evento.
series

string

Il nome della serie.
updateTime

string (Timestamp format)

Il timestamp dell'aggiornamento dell'evento.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa cluster:

  • visionai.clusters.watch

Per ulteriori informazioni, consulta la documentazione di IAM.

EventUpdateFilter

EventUpdateFilter è il filtro che gli osservatori possono specificare per gli aggiornamenti degli eventi che vogliono ricevere.

Rappresentazione 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.
}
Campi

Campo unione start_time.

start_time può essere solo uno dei seguenti:
specialMode

enum (SpecialMode)

Modalità speciali diverse da un timestamp specifico.
specificTime

string (Timestamp format)

Timestamp specifico dopo il quale vengono eseguiti gli aggiornamenti dell'evento.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

SpecialMode

Modalità speciali diverse da un timestamp specifico.

Enum
SPECIAL_MODE_UNSPECIFIED Modalità speciale non specificata.
BEGINNING Per modalità speciale BEGINNING si intendono tutti gli eventi attualmente disponibili e gli aggiornamenti degli eventi in arrivo.
LATEST La modalità speciale LATEST indica solo gli eventi più recenti e gli aggiornamenti degli eventi in arrivo.

EventUpdateType

Il tipo di aggiornamenti degli eventi. Può essere esteso in futuro per altri casi d'uso, ad esempio EVENT_DETACHED_FROM_STREAM e altri.

Enum
EVENT_UPDATE_TYPE_UNSPECIFIED Tipo di aggiornamento evento non specificato.
EVENT_AVAILABLE_ON_STREAM L'evento è disponibile per la lettura in uno stream.
EVENT_HEARTBEAT Messaggio di heartbeat utilizzato per monitorare l'attività della connessione gRPC.