Package com.atlan.model.lineage

Class OpenLineageEvent

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.lineage.OpenLineageEvent

All Implemented Interfaces:

Serializable

public class OpenLineageEvent
extends AtlanObject

Atlan wrapper for abstracting OpenLineage events.

An event is a point-in-time representation of the state of a run.

You must have at least two states for any run for Atlan to process it for lineage:

• START to indicate that a run has begun
• One of the following to indicate that the run has finished:
  • COMPLETE to signify that execution of the run has concluded
  • ABORT to signify the run has been stopped abnormally
  • FAIL to signify the run has failed

In addition, for lineage to show any inputs and outputs to a process in Atlan, at least one of the events must have inputs and outputs defined. It is not necessary to include these on all events; they will be merged from across all events for the same run (by matching on runId).

For more details, see OpenLineage docs.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenLineageEvent.OpenLineageEventBuilder<C extends OpenLineageEvent,B extends OpenLineageEvent.OpenLineageEventBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenLineageEvent(OpenLineageEvent.OpenLineageEventBuilder<?,?> b)
	OpenLineageEvent(io.openlineage.client.OpenLineage.BaseEvent event)

Method Summary

Modifier and Type	Method	Description
static OpenLineageEvent.OpenLineageEventBuilder<?,?>	_internal()
protected boolean	canEqual(Object other)
static OpenLineageEvent.OpenLineageEventBuilder<?,?>	creator(OpenLineageRun run, io.openlineage.client.OpenLineage.RunEvent.EventType type)	Builds the minimal object necessary to create an OpenLineage event.
void	emit(AtlanClient client)	Send the OpenLineage event to Atlan to be processed.
boolean	equals(Object o)
int	hashCode()
OpenLineageEvent.OpenLineageEventBuilder<?,?>	toBuilder()
String	toJson(AtlanClient client)	Serialize the object to a JSON string.
String	toString()

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OpenLineageEvent

public OpenLineageEvent(io.openlineage.client.OpenLineage.BaseEvent event)

OpenLineageEvent

protected OpenLineageEvent(OpenLineageEvent.OpenLineageEventBuilder<?,?> b)

Method Details

creator

public static OpenLineageEvent.OpenLineageEventBuilder<?,?> creator(OpenLineageRun run,
 io.openlineage.client.OpenLineage.RunEvent.EventType type)

Builds the minimal object necessary to create an OpenLineage event.

Parameters:

run - the OpenLineage run for which to create a new event

Returns:

the minimal request necessary to create the event, as a builder

emit

public void emit(AtlanClient client)
          throws AtlanException

Send the OpenLineage event to Atlan to be processed.

Parameters:

client - connectivity to an Atlan tenant

Throws:

AtlanException - on any API communication issues

toJson

public String toJson(AtlanClient client)

Serialize the object to a JSON string.

Overrides:

toJson in class AtlanObject

Parameters:

client - the client through which to serialize the object

Returns:

the serialized JSON string

_internal

public static OpenLineageEvent.OpenLineageEventBuilder<?,?> _internal()

toBuilder

public OpenLineageEvent.OpenLineageEventBuilder<?,?> toBuilder()

equals

public boolean equals(Object o)

Overrides:

equals in class AtlanObject

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AtlanObject

hashCode

public int hashCode()

Overrides:

hashCode in class AtlanObject

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AtlanObject