Module types 

The read-API message types, re-exported from headwaters_proto.

These are the owned proto messages the HeadwatersClient returns. Their open-ended facets / data / fields / events fields are google.protobuf.Struct; struct_to_json converts one to a serde_json::Value so callers can read it without depending on buffa.

Structs

Dataset

— datasets —

DatasetVersion

One historical version of a dataset’s schema. A new version is recorded each time the schema changes.

DatasetVersionId

EntityId

A {namespace, name} reference to a job or dataset.

GetAssetStatsRequest

GetColumnLineageRequest

GetDatasetRequest

GetJobRequest

GetJobRunsRequest

GetLineageEventStatsRequest

GetLineageRequest

GetRunFacetsRequest

GetTagDownstreamRequest

JobDetail

— jobs —

LineageEdge

— lineage / column-lineage graph —

LineageGraph

A lineage graph: the set of nodes reached from the requested seed, each carrying its own incident edges. Returned by GetLineage and GetColumnLineage.

LineageNode

One node in a lineage graph, addressed by its nodeId (id). in_edges / out_edges list the edges incident to this node (upstream and downstream respectively); follow them across nodes to walk the graph.

ListDatasetVersionsRequest

ListDatasetVersionsResponse

ListDatasetsRequest

ListDatasetsResponse

ListEventsRequest

ListEventsResponse

— events feed —

ListJobsRequest

ListJobsResponse

ListNamespacesRequest

— request messages —

ListNamespacesResponse

ListRunsResponse

ListTagsRequest

ListTagsResponse

Namespace

— namespaces —

RunDetail

A single execution of a job.

RunFacetsResponse

— run facets —

SearchRequest

SearchResponse

SearchResult

— search —

StatBucket

— stats —

StatsResponse

A time series of StatBuckets. Returned by the stats endpoints; on the REST surface it serializes as a bare JSON array.

Tag

— tags —

TagPropagation

Every field a tag reaches downstream through column lineage, including the originally tagged fields. Returned by GetTagDownstream.

TaggedField

A dataset field carrying a tag, directly or by propagation through column lineage.

Enums

DatasetType

Storage kind of a dataset. Currently always DB_TABLE.

EntityKind

Kind of a graph node or search hit. DATASET_FIELD is column-level and only appears in column-lineage graphs.

JobType

How a job processes data. Currently always BATCH — the event log does not yet distinguish streaming jobs.

RunState

Lifecycle state of a run, derived from its OpenLineage events. COMPLETED / FAILED / ABORTED are terminal.

Functions

struct_to_json

Convert an open-ended Struct into a serde_json::Value (always a JSON object). Use it to read facets / data / fields / events without touching buffa types directly.

Type Aliases

Struct

The google.protobuf.Struct carried by open-ended fields (facets, data, schema fields, raw events).