REST Resource: projects.locations.processes.runs.lineageEvents

Resource: LineageEvent

A lineage event represents an operation on assets. Within the operation, the data flows from the source to the target defined in the links field.

JSON representation
{
  "name": string,
  "links": [
    {
      object (EventLink)
    }
  ],
  "startTime": string,
  "endTime": string
}
Fields
name

string

Immutable. The resource name of the lineage event. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineageEvent}. Can be specified or auto-assigned. {lineageEvent} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.

startTime

string (Timestamp format)

Required. The beginning of the transformation which resulted in this lineage event. For streaming scenarios, it should be the beginning of the period from which the lineage is being reported.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Optional. The end of the transformation which resulted in this lineage event. For streaming scenarios, it should be the end of the period from which the lineage is being reported.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

EntityReference

The soft reference to everything you can attach a lineage event to.

JSON representation
{
  "fullyQualifiedName": string,
  "field": [
    string
  ]
}
Fields
fullyQualifiedName

string

Required. Fully Qualified Name (FQN) of the entity.

field[]

string

Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage

For example to address "salary.net" subfield where "salary" is a column and "net" is a proto field two values in the field should be reported, the first is "salary" and the second is "net".

Each field length is limited to 500 characters. Maximum supported nesting level is 20.

DependencyInfo

Dependency info describes how one entity depends on another.

JSON representation
{
  "dependencyType": enum (DependencyType)
}
Fields
dependencyType

enum (DependencyType)

Required. Type of dependency.

DependencyType

Type of dependency between entities.

Enums
DEPENDENCY_TYPE_UNSPECIFIED Dependency type unspecified.
EXACT_COPY Exact data copy without any change.
OTHER Other types of dependencies like filtering or grouping.

Methods

create

Creates a new lineage event.

delete

Deletes the lineage event with the specified name.

get

Gets details of a specified lineage event.

list

Lists lineage events in the given project and location.