watch

type ChainNode struct {
	// event's cluster time
	ClusterTime types.TimeStamp `json:"cluster_time"`
	// event's document object id, as is the value of "_id" in a document.
	Oid string `json:"oid"`
	// event's type
	EventType EventType `json:"type"`
	// event's resume token, if token is "", then it's a head, and no tail
	Token string `json:"token"`
	// the current node's cursor
	Cursor string `json:"cursor"`
	// generated by cmdb, and is 1:1 with mongodb's resume token
	// the next cursor's value
	NextCursor string `json:"next_cursor"`
}

type Cursor struct {
	Type        CursorType
	ClusterTime types.TimeStamp
	// a random hex string to avoid the caller to generated a self-defined cursor.
	Oid string
}

type CursorType string

type DetailInterface interface {
	Name() string
}

type EventType string

type JsonString string

type WatchEventDetail struct {
	Cursor    string     `json:"bk_cursor"`
	Resource  CursorType `json:"bk_resource"`
	EventType EventType  `json:"bk_event_type"`
	// Default instance is JsonString type
	Detail DetailInterface `json:"bk_detail"`
}

type WatchEventOptions struct {
	// event types you want to care, empty means all.
	EventTypes []EventType `json:"bk_event_types"`
	// the fields you only care, if nil, means all.
	Fields []string `json:"bk_fields"`
	// unix seconds time to where you want to watch from.
	// it's like Cursor, but StartFrom and Cursor can not use at the same time.
	StartFrom int64 `json:"bk_start_from"`
	// the cursor you hold previous, means you want to watch event form here.
	Cursor string `json:"bk_cursor"`
	// the resource kind you want to watch
	Resource CursorType `json:"bk_resource"`
}

type WatchResp struct {
	// watched events or not
	Watched bool                `json:"bk_watched"`
	Events  []*WatchEventDetail `json:"bk_events"`
}