지정된 스트림에서 발생하는 이벤트 업데이트를 확인합니다.
HTTP 요청
POST https://{endpoint}/v1/{cluster=projects/*/locations/*/clusters/*}:watchEvents
여기서 {endpoint}
는 지원되는 서비스 엔드포인트 중 하나입니다.
URL은 gRPC 트랜스코딩 구문을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
cluster |
리소스의 상위 요소입니다. |
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{
"watcherId": string,
"streams": [
string
],
"eventUpdateFilter": {
object ( |
필드 | |
---|---|
watcherId |
고유 ID는 스트림 시청자를 식별합니다. |
streams[] |
시청할 스트림의 이름 또는 스트림 세트입니다. |
eventUpdateFilter |
관찰자가 수신할 이벤트 업데이트를 지정할 수 있는 필터입니다. |
heartbeatIntervalSecond |
HeartbeatIntervalSecond는 gRPC 스트리밍 서버에서 반환된 하트비트 응답의 간격 (초)을 정의합니다. 기본값 0은 하트비트가 반환되지 않음을 의미합니다. |
응답 본문
성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.
각 응답 메시지에는 이벤트 업데이트가 하나 포함됩니다.
JSON 표현 |
---|
{
"updateType": enum ( |
필드 | |
---|---|
updateType |
이벤트 업데이트 유형입니다. |
stream |
이벤트가 연결된 스트림의 이름입니다. |
event |
이벤트 이름입니다. |
series |
시리즈의 이름입니다. |
updateTime |
이벤트 업데이트가 발생한 시점의 타임스탬프입니다. RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
승인 범위
다음 OAuth 범위가 필요합니다.
https://www.googleapis.com/auth/cloud-platform
자세한 내용은 인증 개요를 참조하세요.
IAM 권한
cluster
리소스에 대해서는 다음 IAM 권한이 필요합니다.
visionai.clusters.watch
자세한 내용은 IAM 문서를 참조하세요.
EventUpdateFilter
EventUpdateFilter는 관찰자가 수신하려는 이벤트 업데이트를 지정할 수 있는 필터입니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드
|
|
specialMode |
특정 타임스탬프 이외의 특수 모드 |
specificTime |
이벤트 업데이트가 발생한 후의 특정 타임스탬프입니다. RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 |
SpecialMode
특정 타임스탬프 이외의 특수 모드
열거형 | |
---|---|
SPECIAL_MODE_UNSPECIFIED |
지정되지 않은 특수 모드입니다. |
BEGINNING |
BEGINNING(시작) 특수 모드는 현재 사용 가능한 모든 이벤트와 수신되는 이벤트 업데이트를 의미합니다. |
LATEST |
LATEST(최신) 특수 모드는 최신 이벤트 및 수신 중인 이벤트 업데이트만 표시합니다. |
EventUpdateType
이벤트 업데이트 유형입니다. 향후 다른 사용 사례에 맞게 확장될 수 있습니다(예: EVENT_DETACHED_FROM_STREAM 등).
열거형 | |
---|---|
EVENT_UPDATE_TYPE_UNSPECIFIED |
이벤트 업데이트 유형이 지정되지 않았습니다. |
EVENT_AVAILABLE_ON_STREAM |
스트림에서 이벤트를 읽을 수 있습니다. |
EVENT_HEARTBEAT |
gRPC 연결의 활성을 추적하는 데 사용되는 하트비트 메시지입니다. |