Package io.openlineage.client

Class OpenLineage.RunEventBuilder

java.lang.Object

io.openlineage.client.OpenLineage.RunEventBuilder

All Implemented Interfaces:

OpenLineage.Builder<OpenLineage.RunEvent>

Enclosing class:

OpenLineage

public final class OpenLineage.RunEventBuilder
extends java.lang.Object
implements OpenLineage.Builder<OpenLineage.RunEvent>

builder class for RunEvent

Constructor Summary

Constructors

Constructor	Description
RunEventBuilder()

Method Summary

Modifier and Type	Method	Description
OpenLineage.RunEvent	build()	build an instance of RunEvent from the fields set in the builder
OpenLineage.RunEventBuilder	eventTime(java.time.ZonedDateTime eventTime)
OpenLineage.RunEventBuilder	eventType(OpenLineage.RunEvent.EventType eventType)
OpenLineage.RunEventBuilder	inputs(java.util.List<OpenLineage.InputDataset> inputs)
OpenLineage.RunEventBuilder	job(OpenLineage.Job job)
OpenLineage.RunEventBuilder	outputs(java.util.List<OpenLineage.OutputDataset> outputs)
OpenLineage.RunEventBuilder	run(OpenLineage.Run run)

Methods inherited from class java.lang.Object

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

Constructor Detail

RunEventBuilder

public RunEventBuilder()

Method Detail

eventTime

public OpenLineage.RunEventBuilder eventTime(java.time.ZonedDateTime eventTime)

Parameters:

eventTime - the time the event occurred at

Returns:

this

eventType

public OpenLineage.RunEventBuilder eventType(OpenLineage.RunEvent.EventType eventType)

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

Returns:

this

run

public OpenLineage.RunEventBuilder run(OpenLineage.Run run)

Parameters:

run - the run

Returns:

this

job

public OpenLineage.RunEventBuilder job(OpenLineage.Job job)

Parameters:

job - the job

Returns:

this

inputs

public OpenLineage.RunEventBuilder inputs(java.util.List<OpenLineage.InputDataset> inputs)

Parameters:

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

Returns:

this

outputs

public OpenLineage.RunEventBuilder outputs(java.util.List<OpenLineage.OutputDataset> outputs)

Parameters:

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

Returns:

this

build

public OpenLineage.RunEvent build()

build an instance of RunEvent from the fields set in the builder

Specified by:

build in interface OpenLineage.Builder<OpenLineage.RunEvent>

Returns:

the constructed type