Google Cloud Data Catalog Lineage V1 Client - Class LineageEvent (1.0.1)

Reference documentation and code samples for the Google Cloud Data Catalog Lineage V1 Client class 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.

Generated from protobuf message google.cloud.datacatalog.lineage.v1.LineageEvent

Namespace

Google \ Cloud \ DataCatalog \ Lineage \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ links array<EventLink>

Optional. List of source-target pairs. Can't contain more than 100 tuples.

↳ start_time Google\Protobuf\Timestamp

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.

↳ end_time Google\Protobuf\Timestamp

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.

getName

Immutable. The resource name of the lineage event.

Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}. Can be specified or auto-assigned. {lineage_event} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.

Returns
Type Description
string

setName

Immutable. The resource name of the lineage event.

Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}. Can be specified or auto-assigned. {lineage_event} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.

Parameter
Name Description
var string
Returns
Type Description
$this

Optional. List of source-target pairs. Can't contain more than 100 tuples.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

Optional. List of source-target pairs. Can't contain more than 100 tuples.

Parameter
Name Description
var array<EventLink>
Returns
Type Description
$this

getStartTime

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.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

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.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this