Package com.atlan.model.lineage

Class OpenLineageJob

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.lineage.OpenLineageJob
All Implemented Interfaces:
Serializable
public class OpenLineageJob extends AtlanObject
Atlan wrapper for abstracting OpenLineage jobs.

A job is a process that consumes or produces datasets.

This is abstract, and can map to different things in different operational contexts. For example, a job could be a task in a workflow orchestration system. It could also be a model, a query, or a checkpoint. Depending on the system under observation, a Job can represent a small or large amount of work.

For more details, see OpenLineage docs.
See Also:

  • Constructor Details

    • OpenLineageJob

      public OpenLineageJob(io.openlineage.client.OpenLineage openLineage, io.openlineage.client.OpenLineage.Job job)
      Pass-through constructor for an Atlan wrapping of an existing OpenLineage job.
      Parameters:
      openLineage - definition of the OpenLineage producer
      job - an OpenLineage job object that already exists

    • OpenLineageJob

      protected OpenLineageJob(OpenLineageJob.OpenLineageJobBuilder<?,?> b)

  • Method Details

    • creator

      public static OpenLineageJob.OpenLineageJobBuilder<?,?> creator(String connectionName, String jobName, String producer)
      Builds the minimal object necessary to create an OpenLineage job.
      Parameters:
      connectionName - name of the Spark connection in which the OpenLineage job should be created
      jobName - unique name of the job - if it already exists the existing job will be updated
      producer - URI indicating the code or software that implements this job
      Returns:
      the minimal request necessary to create the job, as a builder

    • createDataset

      public OpenLineageDataset.OpenLineageDatasetBuilder<?,?> createDataset(String namespace, String assetName)
      Builds the minimal object necessary to create an OpenLineage dataset. Note: before you can use the dataset, you will need to wire it as either an input or output using either toInput() or toOutput().
      Parameters:
      namespace - name of the source of the asset (see: https://github.com/OpenLineage/OpenLineage/blob/main/spec/Naming.md)
      assetName - name of the asset, by OpenLineage standard (for example, DB.SCHEMA.TABLE)
      Returns:
      the minimal request necessary to create the dataset, as a builder

    • createInput

      public OpenLineageInputDataset.OpenLineageInputDatasetBuilder<?,?> createInput(String namespace, String assetName)
      Builds the minimal object necessary to create an OpenLineage dataset, wired to use as an input (source) for lineage.
      Parameters:
      namespace - name of the source of the asset (see: https://github.com/OpenLineage/OpenLineage/blob/main/spec/Naming.md)
      assetName - name of the asset, by OpenLineage standard (for example, DB.SCHEMA.TABLE)
      Returns:
      the minimal request necessary to create the dataset, as a builder

    • createOutput

      public OpenLineageOutputDataset.OpenLineageOutputDatasetBuilder<?,?> createOutput(String namespace, String assetName)
      Builds the minimal object necessary to create an OpenLineage dataset, wired to use as an output (target) for lineage.
      Parameters:
      namespace - name of the source of the asset (see: https://github.com/OpenLineage/OpenLineage/blob/main/spec/Naming.md)
      assetName - name of the asset, by OpenLineage standard (for example, DB.SCHEMA.TABLE)
      Returns:
      the minimal request necessary to create the dataset, as a builder

    • 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 OpenLineageJob.OpenLineageJobBuilder<?,?> _internal()

    • toBuilder

      public OpenLineageJob.OpenLineageJobBuilder<?,?> 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

    • getOpenLineage

      public io.openlineage.client.OpenLineage getOpenLineage()
      Producer definition for OpenLineage.