Package io.openlineage.server

Class OpenLineage.RunEvent

java.lang.Object

io.openlineage.server.OpenLineage.RunEvent

All Implemented Interfaces:

OpenLineage.BaseEvent

Enclosing class:

OpenLineage

public static final class OpenLineage.RunEvent
extends Object
implements OpenLineage.BaseEvent

model class for RunEvent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenLineage.RunEvent.EventType

Constructor Summary

Constructors

Constructor	Description
RunEvent(ZonedDateTime eventTime, URI producer, URI schemaURL, OpenLineage.RunEvent.EventType eventType, OpenLineage.Run run, OpenLineage.Job job, List<OpenLineage.InputDataset> inputs, List<OpenLineage.OutputDataset> outputs)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalProperties()
ZonedDateTime	getEventTime()
OpenLineage.RunEvent.EventType	getEventType()
List<OpenLineage.InputDataset>	getInputs()
OpenLineage.Job	getJob()
List<OpenLineage.OutputDataset>	getOutputs()
URI	getProducer()
OpenLineage.Run	getRun()
URI	getSchemaURL()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RunEvent

public RunEvent(ZonedDateTime eventTime,
 URI producer,
 URI schemaURL,
 OpenLineage.RunEvent.EventType eventType,
 OpenLineage.Run run,
 OpenLineage.Job job,
 List<OpenLineage.InputDataset> inputs,
 List<OpenLineage.OutputDataset> outputs)

Parameters:

eventTime - the time the event occurred at

producer - URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha

schemaURL - The JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this RunEvent

eventType - the current transition of the run state. It is required to issue 1 START event and 1 of [ COMPLETE, ABORT, FAIL ] event per run. Additional events with OTHER eventType can be added to the same run. For example to send additional metadata after the run is complete

run - the run

job - the job

inputs - The set of **input** datasets.

outputs - The set of **output** datasets.

Method Details

getEventTime

public ZonedDateTime getEventTime()

Specified by:

getEventTime in interface OpenLineage.BaseEvent

Returns:

the time the event occurred at

getProducer

public URI getProducer()

Specified by:

getProducer in interface OpenLineage.BaseEvent

Returns:

URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha

getSchemaURL

public URI getSchemaURL()

Specified by:

getSchemaURL in interface OpenLineage.BaseEvent

Returns:

The JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this RunEvent

getEventType

public OpenLineage.RunEvent.EventType getEventType()

Returns:

the current transition of the run state. It is required to issue 1 START event and 1 of [ COMPLETE, ABORT, FAIL ] event per run. Additional events with OTHER eventType can be added to the same run. For example to send additional metadata after the run is complete

getRun

public OpenLineage.Run getRun()

getJob

public OpenLineage.Job getJob()

getInputs

public List<OpenLineage.InputDataset> getInputs()

Returns:

The set of **input** datasets.

getOutputs

public List<OpenLineage.OutputDataset> getOutputs()

Returns:

The set of **output** datasets.

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Specified by:

getAdditionalProperties in interface OpenLineage.BaseEvent

Returns:

additional properties