io.openlineage.server

Class OpenLineage.RunEvent

java.lang.Object

io.openlineage.server.OpenLineage.RunEvent

Enclosing class:

OpenLineage

public static final class OpenLineage.RunEvent
extends java.lang.Object

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RunEvent

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

Parameters:

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

eventTime - the time the event occurred at

run - the run

job - the job

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

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

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

Method Detail

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

getEventTime

public java.time.ZonedDateTime getEventTime()

Returns:

the time the event occurred at

getRun

public OpenLineage.Run getRun()

getJob

public OpenLineage.Job getJob()

getInputs

public java.util.List<OpenLineage.InputDataset> getInputs()

Returns:

The set of **input** datasets.

getOutputs

public java.util.List<OpenLineage.OutputDataset> getOutputs()

Returns:

The set of **output** datasets.

getProducer

public java.net.URI getProducer()

Returns:

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

getSchemaURL

public java.net.URI getSchemaURL()

Returns:

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

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

Returns:

additional properties