Package io.openlineage.client

Class OpenLineage

java.lang.Object

io.openlineage.client.OpenLineage

public final class OpenLineage
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenLineage.BaseFacet
static class	OpenLineage.CustomFacet
class	OpenLineage.CustomFacetBuilder
static class	OpenLineage.DataQualityMetricsInputDatasetFacet
class	OpenLineage.DataQualityMetricsInputDatasetFacetBuilder
static class	OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetrics
static class	OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditional
static class	OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalBuilder
static class	OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles
static class	OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder
static class	OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsBuilder
static interface	OpenLineage.Dataset
static class	OpenLineage.DatasetFacets
static class	OpenLineage.DatasetFacetsBuilder
static class	OpenLineage.DatasourceDatasetFacet
class	OpenLineage.DatasourceDatasetFacetBuilder
static class	OpenLineage.DocumentationDatasetFacet
class	OpenLineage.DocumentationDatasetFacetBuilder
static class	OpenLineage.DocumentationJobFacet
class	OpenLineage.DocumentationJobFacetBuilder
static class	OpenLineage.InputDataset
static class	OpenLineage.InputDatasetBuilder
static class	OpenLineage.InputDatasetInputFacets
static class	OpenLineage.InputDatasetInputFacetsBuilder
static class	OpenLineage.Job
static class	OpenLineage.JobBuilder
static class	OpenLineage.JobFacets
static class	OpenLineage.JobFacetsBuilder
static class	OpenLineage.NominalTimeRunFacet
class	OpenLineage.NominalTimeRunFacetBuilder
static class	OpenLineage.OutputDataset
static class	OpenLineage.OutputDatasetBuilder
static class	OpenLineage.OutputDatasetOutputFacets
static class	OpenLineage.OutputDatasetOutputFacetsBuilder
static class	OpenLineage.OutputStatisticsOutputDatasetFacet
class	OpenLineage.OutputStatisticsOutputDatasetFacetBuilder
static class	OpenLineage.ParentRunFacet
class	OpenLineage.ParentRunFacetBuilder
static class	OpenLineage.ParentRunFacetJob
static class	OpenLineage.ParentRunFacetJobBuilder
static class	OpenLineage.ParentRunFacetRun
static class	OpenLineage.ParentRunFacetRunBuilder
static class	OpenLineage.Run
static class	OpenLineage.RunBuilder
static class	OpenLineage.RunEvent
class	OpenLineage.RunEventBuilder
static class	OpenLineage.RunFacets
static class	OpenLineage.RunFacetsBuilder
static class	OpenLineage.SchemaDatasetFacet
class	OpenLineage.SchemaDatasetFacetBuilder
static class	OpenLineage.SchemaDatasetFacetFields
static class	OpenLineage.SchemaDatasetFacetFieldsBuilder
static class	OpenLineage.SourceCodeLocationJobFacet
class	OpenLineage.SourceCodeLocationJobFacetBuilder
static class	OpenLineage.SQLJobFacet
class	OpenLineage.SQLJobFacetBuilder

Constructor Summary

Constructors

Constructor	Description
OpenLineage(java.net.URI producer)

Method Summary

Modifier and Type	Method	Description
OpenLineage.CustomFacet	newCustomFacet()
OpenLineage.CustomFacetBuilder	newCustomFacetBuilder()
OpenLineage.DataQualityMetricsInputDatasetFacet	newDataQualityMetricsInputDatasetFacet(java.lang.Long rowCount, java.lang.Long bytes, OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetrics columnMetrics)
OpenLineage.DataQualityMetricsInputDatasetFacetBuilder	newDataQualityMetricsInputDatasetFacetBuilder()
OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetrics	newDataQualityMetricsInputDatasetFacetColumnMetrics()
OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditional	newDataQualityMetricsInputDatasetFacetColumnMetricsAdditional(java.lang.Long nullCount, java.lang.Long distinctCount, java.lang.Double sum, java.lang.Double count, java.lang.Double min, java.lang.Double max, OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles quantiles)
OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalBuilder	newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalBuilder()
OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles	newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles()
OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder	newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder()
OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsBuilder	newDataQualityMetricsInputDatasetFacetColumnMetricsBuilder()
OpenLineage.DatasetFacets	newDatasetFacets(OpenLineage.DocumentationDatasetFacet documentation, OpenLineage.SchemaDatasetFacet schema, OpenLineage.DatasourceDatasetFacet dataSource)
OpenLineage.DatasetFacetsBuilder	newDatasetFacetsBuilder()
OpenLineage.DatasourceDatasetFacet	newDatasourceDatasetFacet(java.lang.String name, java.net.URI uri)
OpenLineage.DatasourceDatasetFacetBuilder	newDatasourceDatasetFacetBuilder()
OpenLineage.DocumentationDatasetFacet	newDocumentationDatasetFacet(java.lang.String description)
OpenLineage.DocumentationDatasetFacetBuilder	newDocumentationDatasetFacetBuilder()
OpenLineage.DocumentationJobFacet	newDocumentationJobFacet(java.lang.String description)
OpenLineage.DocumentationJobFacetBuilder	newDocumentationJobFacetBuilder()
OpenLineage.InputDataset	newInputDataset(java.lang.String namespace, java.lang.String name, OpenLineage.DatasetFacets facets, OpenLineage.InputDatasetInputFacets inputFacets)
OpenLineage.InputDatasetBuilder	newInputDatasetBuilder()
OpenLineage.InputDatasetInputFacets	newInputDatasetInputFacets(OpenLineage.DataQualityMetricsInputDatasetFacet dataQualityMetrics)
OpenLineage.InputDatasetInputFacetsBuilder	newInputDatasetInputFacetsBuilder()
OpenLineage.Job	newJob(java.lang.String namespace, java.lang.String name, OpenLineage.JobFacets facets)
OpenLineage.JobBuilder	newJobBuilder()
OpenLineage.JobFacets	newJobFacets(OpenLineage.DocumentationJobFacet documentation, OpenLineage.SourceCodeLocationJobFacet sourceCodeLocation, OpenLineage.SQLJobFacet sql)
OpenLineage.JobFacetsBuilder	newJobFacetsBuilder()
OpenLineage.NominalTimeRunFacet	newNominalTimeRunFacet(java.time.ZonedDateTime nominalStartTime, java.time.ZonedDateTime nominalEndTime)
OpenLineage.NominalTimeRunFacetBuilder	newNominalTimeRunFacetBuilder()
OpenLineage.OutputDataset	newOutputDataset(java.lang.String namespace, java.lang.String name, OpenLineage.DatasetFacets facets, OpenLineage.OutputDatasetOutputFacets outputFacets)
OpenLineage.OutputDatasetBuilder	newOutputDatasetBuilder()
OpenLineage.OutputDatasetOutputFacets	newOutputDatasetOutputFacets(OpenLineage.OutputStatisticsOutputDatasetFacet outputStatistics)
OpenLineage.OutputDatasetOutputFacetsBuilder	newOutputDatasetOutputFacetsBuilder()
OpenLineage.OutputStatisticsOutputDatasetFacet	newOutputStatisticsOutputDatasetFacet(java.lang.Long rowCount, java.lang.Long size)
OpenLineage.OutputStatisticsOutputDatasetFacetBuilder	newOutputStatisticsOutputDatasetFacetBuilder()
OpenLineage.ParentRunFacet	newParentRunFacet(OpenLineage.ParentRunFacetRun run, OpenLineage.ParentRunFacetJob job)
OpenLineage.ParentRunFacetBuilder	newParentRunFacetBuilder()
OpenLineage.ParentRunFacetJob	newParentRunFacetJob(java.lang.String namespace, java.lang.String name)
OpenLineage.ParentRunFacetJobBuilder	newParentRunFacetJobBuilder()
OpenLineage.ParentRunFacetRun	newParentRunFacetRun(java.util.UUID runId)
OpenLineage.ParentRunFacetRunBuilder	newParentRunFacetRunBuilder()
OpenLineage.Run	newRun(java.util.UUID runId, OpenLineage.RunFacets facets)
OpenLineage.RunBuilder	newRunBuilder()
OpenLineage.RunEvent	newRunEvent(java.lang.String eventType, java.time.ZonedDateTime eventTime, OpenLineage.Run run, OpenLineage.Job job, java.util.List<OpenLineage.InputDataset> inputs, java.util.List<OpenLineage.OutputDataset> outputs)
OpenLineage.RunEventBuilder	newRunEventBuilder()
OpenLineage.RunFacets	newRunFacets(OpenLineage.NominalTimeRunFacet nominalTime, OpenLineage.ParentRunFacet parent)
OpenLineage.RunFacetsBuilder	newRunFacetsBuilder()
OpenLineage.SchemaDatasetFacet	newSchemaDatasetFacet(java.util.List<OpenLineage.SchemaDatasetFacetFields> fields)
OpenLineage.SchemaDatasetFacetBuilder	newSchemaDatasetFacetBuilder()
OpenLineage.SchemaDatasetFacetFields	newSchemaDatasetFacetFields(java.lang.String name, java.lang.String type, java.lang.String description)
OpenLineage.SchemaDatasetFacetFieldsBuilder	newSchemaDatasetFacetFieldsBuilder()
OpenLineage.SourceCodeLocationJobFacet	newSourceCodeLocationJobFacet(java.lang.String type, java.net.URI url, java.lang.String repoUrl, java.lang.String path, java.lang.String version, java.lang.String tag, java.lang.String branch)
OpenLineage.SourceCodeLocationJobFacetBuilder	newSourceCodeLocationJobFacetBuilder()
OpenLineage.SQLJobFacet	newSQLJobFacet(java.lang.String query)
OpenLineage.SQLJobFacetBuilder	newSQLJobFacetBuilder()

Methods inherited from class java.lang.Object

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

Constructor Details

OpenLineage

public OpenLineage(java.net.URI producer)

Method Details

newParentRunFacetRun

public OpenLineage.ParentRunFacetRun newParentRunFacetRun(java.util.UUID runId)

Parameters:

runId - The globally unique ID of the run associated with the job.

Returns:

ParentRunFacetRun

newParentRunFacetRunBuilder

public OpenLineage.ParentRunFacetRunBuilder newParentRunFacetRunBuilder()

newDatasourceDatasetFacet

public OpenLineage.DatasourceDatasetFacet newDatasourceDatasetFacet(java.lang.String name, java.net.URI uri)

Parameters:

name - the name

uri - the uri

Returns:

DatasourceDatasetFacet

newDatasourceDatasetFacetBuilder

public OpenLineage.DatasourceDatasetFacetBuilder newDatasourceDatasetFacetBuilder()

newDocumentationJobFacet

public OpenLineage.DocumentationJobFacet newDocumentationJobFacet(java.lang.String description)

Parameters:

description - The description of the job.

Returns:

DocumentationJobFacet

newDocumentationJobFacetBuilder

public OpenLineage.DocumentationJobFacetBuilder newDocumentationJobFacetBuilder()

newOutputStatisticsOutputDatasetFacet

public OpenLineage.OutputStatisticsOutputDatasetFacet newOutputStatisticsOutputDatasetFacet(java.lang.Long rowCount, java.lang.Long size)

Parameters:

rowCount - The number of rows written to the dataset

size - The size in bytes written to the dataset

Returns:

OutputStatisticsOutputDatasetFacet

newOutputStatisticsOutputDatasetFacetBuilder

public OpenLineage.OutputStatisticsOutputDatasetFacetBuilder newOutputStatisticsOutputDatasetFacetBuilder()

newDataQualityMetricsInputDatasetFacet

public OpenLineage.DataQualityMetricsInputDatasetFacet newDataQualityMetricsInputDatasetFacet(java.lang.Long rowCount, java.lang.Long bytes, OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetrics columnMetrics)

Parameters:

rowCount - The number of rows evaluated

bytes - The size in bytes

columnMetrics - The property key is the column name

Returns:

DataQualityMetricsInputDatasetFacet

newDataQualityMetricsInputDatasetFacetBuilder

public OpenLineage.DataQualityMetricsInputDatasetFacetBuilder newDataQualityMetricsInputDatasetFacetBuilder()

newRunFacets

public OpenLineage.RunFacets newRunFacets(OpenLineage.NominalTimeRunFacet nominalTime, OpenLineage.ParentRunFacet parent)

Parameters:

nominalTime - the nominalTime

parent - the parent

Returns:

RunFacets

newRunFacetsBuilder

public OpenLineage.RunFacetsBuilder newRunFacetsBuilder()

newJobFacets

public OpenLineage.JobFacets newJobFacets(OpenLineage.DocumentationJobFacet documentation, OpenLineage.SourceCodeLocationJobFacet sourceCodeLocation, OpenLineage.SQLJobFacet sql)

Parameters:

documentation - the documentation

sourceCodeLocation - the sourceCodeLocation

sql - the sql

Returns:

JobFacets

newJobFacetsBuilder

public OpenLineage.JobFacetsBuilder newJobFacetsBuilder()

newJob

public OpenLineage.Job newJob(java.lang.String namespace, java.lang.String name, OpenLineage.JobFacets facets)

Parameters:

namespace - The namespace containing that job

name - The unique name for that job within that namespace

facets - The job facets.

Returns:

Job

newJobBuilder

public OpenLineage.JobBuilder newJobBuilder()

newParentRunFacetJob

public OpenLineage.ParentRunFacetJob newParentRunFacetJob(java.lang.String namespace, java.lang.String name)

Parameters:

namespace - The namespace containing that job

name - The unique name for that job within that namespace

Returns:

ParentRunFacetJob

newParentRunFacetJobBuilder

public OpenLineage.ParentRunFacetJobBuilder newParentRunFacetJobBuilder()

newDocumentationDatasetFacet

public OpenLineage.DocumentationDatasetFacet newDocumentationDatasetFacet(java.lang.String description)

Parameters:

description - The description of the dataset.

Returns:

DocumentationDatasetFacet

newDocumentationDatasetFacetBuilder

public OpenLineage.DocumentationDatasetFacetBuilder newDocumentationDatasetFacetBuilder()

newSourceCodeLocationJobFacet

public OpenLineage.SourceCodeLocationJobFacet newSourceCodeLocationJobFacet(java.lang.String type, java.net.URI url, java.lang.String repoUrl, java.lang.String path, java.lang.String version, java.lang.String tag, java.lang.String branch)

Parameters:

type - the source control system

url - the full http URL to locate the file

repoUrl - the URL to the repository

path - the path in the repo containing the source files

version - the current version deployed (not a branch name, the actual unique version)

tag - optional tag name

branch - optional branch name

Returns:

SourceCodeLocationJobFacet

newSourceCodeLocationJobFacetBuilder

public OpenLineage.SourceCodeLocationJobFacetBuilder newSourceCodeLocationJobFacetBuilder()

newParentRunFacet

public OpenLineage.ParentRunFacet newParentRunFacet(OpenLineage.ParentRunFacetRun run, OpenLineage.ParentRunFacetJob job)

Parameters:

run - the run

job - the job

Returns:

ParentRunFacet

newParentRunFacetBuilder

public OpenLineage.ParentRunFacetBuilder newParentRunFacetBuilder()

newOutputDatasetOutputFacets

public OpenLineage.OutputDatasetOutputFacets newOutputDatasetOutputFacets(OpenLineage.OutputStatisticsOutputDatasetFacet outputStatistics)

Parameters:

outputStatistics - the outputStatistics

Returns:

OutputDatasetOutputFacets

newOutputDatasetOutputFacetsBuilder

public OpenLineage.OutputDatasetOutputFacetsBuilder newOutputDatasetOutputFacetsBuilder()

newDatasetFacets

public OpenLineage.DatasetFacets newDatasetFacets(OpenLineage.DocumentationDatasetFacet documentation, OpenLineage.SchemaDatasetFacet schema, OpenLineage.DatasourceDatasetFacet dataSource)

Parameters:

documentation - the documentation

schema - the schema

dataSource - the dataSource

Returns:

DatasetFacets

newDatasetFacetsBuilder

public OpenLineage.DatasetFacetsBuilder newDatasetFacetsBuilder()

newNominalTimeRunFacet

public OpenLineage.NominalTimeRunFacet newNominalTimeRunFacet(java.time.ZonedDateTime nominalStartTime, java.time.ZonedDateTime nominalEndTime)

Parameters:

nominalStartTime - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the nominal start time (included) of the run. AKA the schedule time

nominalEndTime - An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the nominal end time (excluded) of the run. (Should be the nominal start time of the next run)

Returns:

NominalTimeRunFacet

newNominalTimeRunFacetBuilder

public OpenLineage.NominalTimeRunFacetBuilder newNominalTimeRunFacetBuilder()

newSchemaDatasetFacet

public OpenLineage.SchemaDatasetFacet newSchemaDatasetFacet(java.util.List<OpenLineage.SchemaDatasetFacetFields> fields)

Parameters:

fields - The fields of the table.

Returns:

SchemaDatasetFacet

newSchemaDatasetFacetBuilder

public OpenLineage.SchemaDatasetFacetBuilder newSchemaDatasetFacetBuilder()

newSQLJobFacet

public OpenLineage.SQLJobFacet newSQLJobFacet(java.lang.String query)

Parameters:

query - the query

Returns:

SQLJobFacet

newSQLJobFacetBuilder

public OpenLineage.SQLJobFacetBuilder newSQLJobFacetBuilder()

newRun

public OpenLineage.Run newRun(java.util.UUID runId, OpenLineage.RunFacets facets)

Parameters:

runId - The globally unique ID of the run associated with the job.

facets - The run facets.

Returns:

Run

newRunBuilder

public OpenLineage.RunBuilder newRunBuilder()

newCustomFacet

public OpenLineage.CustomFacet newCustomFacet()

Returns:

CustomFacet

newCustomFacetBuilder

public OpenLineage.CustomFacetBuilder newCustomFacetBuilder()

newDataQualityMetricsInputDatasetFacetColumnMetrics

public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetrics newDataQualityMetricsInputDatasetFacetColumnMetrics()

Returns:

DataQualityMetricsInputDatasetFacetColumnMetrics

newDataQualityMetricsInputDatasetFacetColumnMetricsBuilder

public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsBuilder newDataQualityMetricsInputDatasetFacetColumnMetricsBuilder()

newInputDataset

public OpenLineage.InputDataset newInputDataset(java.lang.String namespace, java.lang.String name, OpenLineage.DatasetFacets facets, OpenLineage.InputDatasetInputFacets inputFacets)

Parameters:

namespace - The namespace containing that dataset

name - The unique name for that dataset within that namespace

facets - The facets for this dataset

inputFacets - The input facets for this dataset.

Returns:

InputDataset

newInputDatasetBuilder

public OpenLineage.InputDatasetBuilder newInputDatasetBuilder()

newOutputDataset

public OpenLineage.OutputDataset newOutputDataset(java.lang.String namespace, java.lang.String name, OpenLineage.DatasetFacets facets, OpenLineage.OutputDatasetOutputFacets outputFacets)

Parameters:

namespace - The namespace containing that dataset

name - The unique name for that dataset within that namespace

facets - The facets for this dataset

outputFacets - The output facets for this dataset

Returns:

OutputDataset

newOutputDatasetBuilder

public OpenLineage.OutputDatasetBuilder newOutputDatasetBuilder()

newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles

public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles()

Returns:

DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles

newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder

public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder()

newDataQualityMetricsInputDatasetFacetColumnMetricsAdditional

public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditional newDataQualityMetricsInputDatasetFacetColumnMetricsAdditional(java.lang.Long nullCount, java.lang.Long distinctCount, java.lang.Double sum, java.lang.Double count, java.lang.Double min, java.lang.Double max, OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles quantiles)

Parameters:

nullCount - The number of null values in this column for the rows evaluated

distinctCount - The number of distinct values in this column for the rows evaluated

sum - The total sum of values in this column for the rows evaluated

count - The number of values in this column

min - the min

max - the max

quantiles - The property key is the quantile. Examples: 0.1 0.25 0.5 0.75 1

Returns:

DataQualityMetricsInputDatasetFacetColumnMetricsAdditional

newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalBuilder

public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalBuilder newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalBuilder()

newRunEvent

public OpenLineage.RunEvent newRunEvent(java.lang.String eventType, java.time.ZonedDateTime eventTime, OpenLineage.Run run, OpenLineage.Job job, java.util.List<OpenLineage.InputDataset> inputs, java.util.List<OpenLineage.OutputDataset> outputs)

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 occured at

run - the run

job - the job

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

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

Returns:

RunEvent

newRunEventBuilder

public OpenLineage.RunEventBuilder newRunEventBuilder()

newSchemaDatasetFacetFields

public OpenLineage.SchemaDatasetFacetFields newSchemaDatasetFacetFields(java.lang.String name, java.lang.String type, java.lang.String description)

Parameters:

name - The name of the field.

type - The type of the field.

description - The description of the field.

Returns:

SchemaDatasetFacetFields

newSchemaDatasetFacetFieldsBuilder

public OpenLineage.SchemaDatasetFacetFieldsBuilder newSchemaDatasetFacetFieldsBuilder()

newInputDatasetInputFacets

public OpenLineage.InputDatasetInputFacets newInputDatasetInputFacets(OpenLineage.DataQualityMetricsInputDatasetFacet dataQualityMetrics)

Parameters:

dataQualityMetrics - the dataQualityMetrics

Returns:

InputDatasetInputFacets

newInputDatasetInputFacetsBuilder

public OpenLineage.InputDatasetInputFacetsBuilder newInputDatasetInputFacetsBuilder()