Method: projects.locations.clusters.watchEvents

Observa las actualizaciones de eventos que se producen en las transmisiones determinadas.

Solicitud HTTP

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

En el que {endpoint} es uno de los extremos del servicio admitidos.

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
cluster

string

Es el elemento superior del recurso.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "watcherId": string,
  "streams": [
    string
  ],
  "eventUpdateFilter": {
    object (EventUpdateFilter)
  },
  "heartbeatIntervalSecond": number
}
Campos
watcherId

string

El ID único identifica al usuario que mira las transmisiones.
streams[]

string

Es el nombre del flujo o del conjunto de flujos que se mirarán.
eventUpdateFilter

object (EventUpdateFilter)

Es el filtro que los observadores pueden especificar sobre qué actualizaciones de eventos quieren recibir.
heartbeatIntervalSecond

number

HeartbeatIntervalSecond define el intervalo (en segundos) de la respuesta de la señal de actividad que se muestra desde el servidor de transmisión de gRPC. El valor predeterminado 0 significa que no se mostrará ningún mensaje de estado.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Cada mensaje de respuesta contendrá una actualización de evento.

Representación JSON 
{
  "updateType": enum (EventUpdateType),
  "stream": string,
  "event": string,
  "series": string,
  "updateTime": string
}
Campos
updateType

enum (EventUpdateType)

Es el tipo de actualización del evento.
stream

string

Es el nombre del flujo al que está adjunto el evento.
event

string

Es el nombre del evento.
series

string

Es el nombre de la serie.
updateTime

string (Timestamp format)

Es la marca de tiempo del momento en que se produce la actualización del evento.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso cluster:

  • visionai.clusters.watch

Para obtener más información, consulta la documentación de IAM.

EventUpdateFilter

EventUpdateFilter es el filtro que los observadores pueden especificar sobre qué actualizaciones de eventos quieren recibir.

Representación 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.
}
Campos

Campo de unión start_time.

start_time puede ser una de las siguientes opciones:
specialMode

enum (SpecialMode)

Modos especiales distintos de una marca de tiempo específica
specificTime

string (Timestamp format)

Es la marca de tiempo específica después de la cual se actualiza el evento.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

SpecialMode

Modos especiales distintos de una marca de tiempo específica

Enums
SPECIAL_MODE_UNSPECIFIED No se especificó el modo especial.
BEGINNING El modo especial BEGINNING incluye todos los eventos disponibles actualmente y las actualizaciones de eventos entrantes.
LATEST El modo especial MÁS RECIENTE solo incluye los eventos más recientes y las actualizaciones de eventos entrantes.

EventUpdateType

Es el tipo de actualizaciones de eventos. Se puede extender en el futuro para otros casos de uso, p. ej., EVENT_DETACHED_FROM_STREAM y mucho más.

Enums
EVENT_UPDATE_TYPE_UNSPECIFIED No se especificó el tipo de actualización del evento.
EVENT_AVAILABLE_ON_STREAM El evento está disponible para leerlo en una transmisión.
EVENT_HEARTBEAT Es un mensaje de señal de monitoreo de funcionamiento que se usa para hacer un seguimiento de la actividad de la conexión gRPC.