Method: projects.locations.clusters.watchEvents

Fique de olho nas atualizações de eventos que acontecem nas transmissões.

Solicitação HTTP

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

Em que {endpoint} é um dos endpoints de serviço compatíveis.

Os URLs usam a sintaxe de Transcodificação gRPC.

Parâmetros de caminho

Parâmetros
cluster

string

O pai do recurso.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "watcherId": string,
  "streams": [
    string
  ],
  "eventUpdateFilter": {
    object (EventUpdateFilter)
  },
  "heartbeatIntervalSecond": number
}
Campos
watcherId

string

O ID exclusivo identifica o espectador dos streams.
streams[]

string

O nome do stream ou do conjunto de streams a serem assistidos.
eventUpdateFilter

object (EventUpdateFilter)

O filtro que os observadores podem especificar sobre quais atualizações de eventos eles querem receber.
heartbeatIntervalSecond

number

HeartbeatIntervalSecond define o intervalo (em segundos) da resposta de verificação de funcionamento retornada pelo servidor de streaming gRPC. O padrão 0 significa que nenhum heartbeat será retornado.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Cada mensagem de resposta vai conter uma atualização de evento.

Representação JSON 
{
  "updateType": enum (EventUpdateType),
  "stream": string,
  "event": string,
  "series": string,
  "updateTime": string
}
Campos
updateType

enum (EventUpdateType)

O tipo de atualização do evento.
stream

string

O nome do stream ao qual o evento está anexado.
event

string

O nome do evento.
series

string

O nome da série.
updateTime

string (Timestamp format)

O carimbo de data/hora em que a atualização do evento acontece.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso cluster:

  • visionai.clusters.watch

Para mais informações, consulte a documentação do IAM.

EventUpdateFilter

O EventUpdateFilter é o filtro que os observadores podem especificar sobre quais atualizações de eventos eles querem receber.

Representação 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ão start_time.

start_time pode ser apenas de um dos tipos a seguir:
specialMode

enum (SpecialMode)

Modos especiais diferentes de um carimbo de data/hora específico.
specificTime

string (Timestamp format)

Carimbo de data/hora específico após o qual as atualizações de evento acontecem.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

SpecialMode

Modos especiais diferentes de um carimbo de data/hora específico.

Enums
SPECIAL_MODE_UNSPECIFIED Modo especial não especificado.
BEGINNING O modo especial BEGINNING inclui todos os eventos disponíveis no momento e as atualizações de eventos recebidas.
LATEST O modo especial "LATEST" significa apenas os eventos mais recentes e as atualizações de eventos recebidas.

EventUpdateType

O tipo de atualizações de evento. Pode ser estendido no futuro para outros casos de uso, por exemplo, EVENT_DETACHED_FROM_STREAM e outros.

Enums
EVENT_UPDATE_TYPE_UNSPECIFIED O tipo de atualização do evento não foi especificado.
EVENT_AVAILABLE_ON_STREAM O evento está disponível para leitura em um stream.
EVENT_HEARTBEAT Mensagem de pulso que é usada para rastrear a atividade da conexão gRPC.