Struct FeatureDiffEvent

lib/event/featurediff/v1/types.go:41–68

FeatureDiffEvent represents a change event for a saved search query. It is the contract between the Event Producer and downstream workers (e.g. Push Delivery Worker).

// FeatureDiffEvent represents a change event for a saved search query.
// It is the contract between the Event Producer and downstream workers (e.g. Push Delivery Worker).
type FeatureDiffEvent struct {
	// EventID is the unique identifier for this specific execution/trigger.
	EventID string `json:"event_id"`
	// SearchID is the identifier of the saved search that was checked.
	SearchID string `json:"search_id"`
	// SearchName is the user-provided name for the saved search.
	SearchName string `json:"search_name"`
	// Query is the actual text of the query (e.g. "browsers:chrome").
	// Provided here so consumers don't need to look it up.
	Query string `json:"query"`
	// Reasons contains machine-readable tags explaining why this event was generated
	// (e.g. ["DATA_UPDATED", "QUERY_EDITED"]).
	Reasons []Reason `json:"reasons"`
	// Summary is a JSON string summarizing the changes (e.g. '{"added": 1, "removed": 0}').
	Summary []byte `json:"summary"`
	// StateID is the ID of the full snapshot blob in storage.
	StateID string `json:"state_id"`
	// StateBlobPath is the path to the full snapshot blob in storage.
	StateBlobPath string `json:"state_blob_path"`
	// DiffID is the ID of the diff blob in storage.
	DiffID string `json:"diff_id"`
	// DiffBlobPath is the path to the diff blob in storage.
	DiffBlobPath string `json:"diff_blob_path"`
	// GeneratedAt is the timestamp when the event was created.
	GeneratedAt time.Time `json:"generated_at"`
	// Frequency is the frequency that triggered the generation of this diff.
	Frequency JobFrequency `json:"frequency"`
}

func (FeatureDiffEvent) Kind() string       { return "FeatureDiffEvent" }
func (FeatureDiffEvent) APIVersion() string { return "v1" }