Class OpenLineageRunEvent


  • public class OpenLineageRunEvent
    extends java.lang.Object
    This class represents the content of an open lineage run event as defined in JSON spec https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json. It is used internally in Egeria to pass this information to the Lineage Integrator OMIS's integration connectors.
    • Constructor Summary

      Constructors 
      Constructor Description
      OpenLineageRunEvent()
      Default constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getEventTime()
      Return the time the event occurred at.
      java.lang.String getEventType()
      Return the current transition of the run state.
      java.util.List<OpenLineageInputDataSet> getInputs()
      Return the set of input data sets.
      OpenLineageJob getJob()
      Return the description of the job.
      java.util.List<OpenLineageOutputDataSet> getOutputs()
      Return the set of output data sets.
      java.net.URI getProducer()
      Return the URI identifying the producer of this metadata.
      OpenLineageRun getRun()
      Return the details of the job run.
      java.net.URI getSchemaURL()
      Return the JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet.
      void setEventTime​(java.lang.String eventTime)
      Set up the time the event occurred at.
      void setEventType​(java.lang.String eventType)
      Set up the current transition of the run state.
      void setInputs​(java.util.List<OpenLineageInputDataSet> inputs)
      Set up the set of output data sets.
      void setJob​(OpenLineageJob job)
      Set up the description of the job.
      void setOutputs​(java.util.List<OpenLineageOutputDataSet> outputs)
      Set up the list of output data sets.
      void setProducer​(java.net.URI producer)
      Set up the URI identifying the producer of this metadata.
      void setRun​(OpenLineageRun run)
      Set up details of the run.
      void setSchemaURL​(java.net.URI schemaURL)
      Set up the JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • OpenLineageRunEvent

        public OpenLineageRunEvent()
        Default constructor
    • Method Detail

      • getProducer

        public java.net.URI getProducer()
        Return the URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha.
        Returns:
        URI
      • setProducer

        public void setProducer​(java.net.URI producer)
        Set up the URI identifying the producer of this metadata. For example this could be a git url with a given tag or sha.
        Parameters:
        producer - uri
      • getSchemaURL

        public java.net.URI getSchemaURL()
        Return the JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet.
        Returns:
        uri
      • setSchemaURL

        public void setSchemaURL​(java.net.URI schemaURL)
        Set up the JSON Pointer (https://tools.ietf.org/html/rfc6901) URL to the corresponding version of the schema definition for this facet.
        Parameters:
        schemaURL - uri
      • getEventType

        public java.lang.String getEventType()
        Return 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:
        string ("START", "COMPLETE", "ABORT", "FAIL", "OTHER")
      • setEventType

        public void setEventType​(java.lang.String eventType)
        Set up 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.
        Parameters:
        eventType - string ("START", "COMPLETE", "ABORT", "FAIL", "OTHER")
      • getEventTime

        public java.lang.String getEventTime()
        Return the time the event occurred at.
        Returns:
        zoned time
      • setEventTime

        public void setEventTime​(java.lang.String eventTime)
        Set up the time the event occurred at.
        Parameters:
        eventTime - zoned time
      • getRun

        public OpenLineageRun getRun()
        Return the details of the job run.
        Returns:
        run structure
      • setRun

        public void setRun​(OpenLineageRun run)
        Set up details of the run.
        Parameters:
        run - run structure
      • getJob

        public OpenLineageJob getJob()
        Return the description of the job.
        Returns:
        job structure
      • setJob

        public void setJob​(OpenLineageJob job)
        Set up the description of the job.
        Parameters:
        job - job structure
      • getInputs

        public java.util.List<OpenLineageInputDataSet> getInputs()
        Return the set of input data sets.
        Returns:
        list of data set descriptions
      • setInputs

        public void setInputs​(java.util.List<OpenLineageInputDataSet> inputs)
        Set up the set of output data sets.
        Parameters:
        inputs - list of data set descriptions
      • getOutputs

        public java.util.List<OpenLineageOutputDataSet> getOutputs()
        Return the set of output data sets.
        Returns:
        list of data set descriptions
      • setOutputs

        public void setOutputs​(java.util.List<OpenLineageOutputDataSet> outputs)
        Set up the list of output data sets.
        Parameters:
        outputs - list of data set descriptions