Package io.openlineage.client
Class OpenLineage
java.lang.Object
io.openlineage.client.OpenLineage
public final class OpenLineage
extends java.lang.Object
-
Nested Class Summary
-
Constructor Summary
Constructors Constructor Description OpenLineage(java.net.URI producer)
-
Method Summary
-
Constructor Details
-
OpenLineage
public OpenLineage(java.net.URI producer)
-
-
Method Details
-
newParentRunFacetRun
- Parameters:
runId
- The globally unique ID of the run associated with the job.- Returns:
- ParentRunFacetRun
-
newParentRunFacetRunBuilder
-
newDatasourceDatasetFacet
public OpenLineage.DatasourceDatasetFacet newDatasourceDatasetFacet(java.lang.String name, java.net.URI uri)- Parameters:
name
- the nameuri
- the uri- Returns:
- DatasourceDatasetFacet
-
newDatasourceDatasetFacetBuilder
-
newDocumentationJobFacet
- Parameters:
description
- The description of the job.- Returns:
- DocumentationJobFacet
-
newDocumentationJobFacetBuilder
-
newOutputStatisticsOutputDatasetFacet
public OpenLineage.OutputStatisticsOutputDatasetFacet newOutputStatisticsOutputDatasetFacet(java.lang.Long rowCount, java.lang.Long size)- Parameters:
rowCount
- The number of rows written to the datasetsize
- 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 evaluatedbytes
- The size in bytescolumnMetrics
- 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 nominalTimeparent
- the parent- Returns:
- RunFacets
-
newRunFacetsBuilder
-
newJobFacets
public OpenLineage.JobFacets newJobFacets(OpenLineage.DocumentationJobFacet documentation, OpenLineage.SourceCodeLocationJobFacet sourceCodeLocation, OpenLineage.SQLJobFacet sql)- Parameters:
documentation
- the documentationsourceCodeLocation
- the sourceCodeLocationsql
- the sql- Returns:
- JobFacets
-
newJobFacetsBuilder
-
newJob
public OpenLineage.Job newJob(java.lang.String namespace, java.lang.String name, OpenLineage.JobFacets facets)- Parameters:
namespace
- The namespace containing that jobname
- The unique name for that job within that namespacefacets
- The job facets.- Returns:
- Job
-
newJobBuilder
-
newParentRunFacetJob
public OpenLineage.ParentRunFacetJob newParentRunFacetJob(java.lang.String namespace, java.lang.String name)- Parameters:
namespace
- The namespace containing that jobname
- The unique name for that job within that namespace- Returns:
- ParentRunFacetJob
-
newParentRunFacetJobBuilder
-
newDocumentationDatasetFacet
public OpenLineage.DocumentationDatasetFacet newDocumentationDatasetFacet(java.lang.String description)- Parameters:
description
- The description of the dataset.- Returns:
- DocumentationDatasetFacet
-
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 systemurl
- the full http URL to locate the filerepoUrl
- the URL to the repositorypath
- the path in the repo containing the source filesversion
- the current version deployed (not a branch name, the actual unique version)tag
- optional tag namebranch
- optional branch name- Returns:
- SourceCodeLocationJobFacet
-
newSourceCodeLocationJobFacetBuilder
-
newParentRunFacet
public OpenLineage.ParentRunFacet newParentRunFacet(OpenLineage.ParentRunFacetRun run, OpenLineage.ParentRunFacetJob job)- Parameters:
run
- the runjob
- the job- Returns:
- ParentRunFacet
-
newParentRunFacetBuilder
-
newOutputDatasetOutputFacets
public OpenLineage.OutputDatasetOutputFacets newOutputDatasetOutputFacets(OpenLineage.OutputStatisticsOutputDatasetFacet outputStatistics)- Parameters:
outputStatistics
- the outputStatistics- Returns:
- OutputDatasetOutputFacets
-
newOutputDatasetOutputFacetsBuilder
-
newDatasetFacets
public OpenLineage.DatasetFacets newDatasetFacets(OpenLineage.DocumentationDatasetFacet documentation, OpenLineage.SchemaDatasetFacet schema, OpenLineage.DatasourceDatasetFacet dataSource)- Parameters:
documentation
- the documentationschema
- the schemadataSource
- the dataSource- Returns:
- DatasetFacets
-
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 timenominalEndTime
- 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
-
newSchemaDatasetFacet
public OpenLineage.SchemaDatasetFacet newSchemaDatasetFacet(java.util.List<OpenLineage.SchemaDatasetFacetFields> fields)- Parameters:
fields
- The fields of the table.- Returns:
- SchemaDatasetFacet
-
newSchemaDatasetFacetBuilder
-
newSQLJobFacet
- Parameters:
query
- the query- Returns:
- SQLJobFacet
-
newSQLJobFacetBuilder
-
newRun
- Parameters:
runId
- The globally unique ID of the run associated with the job.facets
- The run facets.- Returns:
- Run
-
newRunBuilder
-
newCustomFacet
- Returns:
- CustomFacet
-
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 datasetname
- The unique name for that dataset within that namespacefacets
- The facets for this datasetinputFacets
- The input facets for this dataset.- Returns:
- InputDataset
-
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 datasetname
- The unique name for that dataset within that namespacefacets
- The facets for this datasetoutputFacets
- The output facets for this dataset- Returns:
- OutputDataset
-
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 evaluateddistinctCount
- The number of distinct values in this column for the rows evaluatedsum
- The total sum of values in this column for the rows evaluatedcount
- The number of values in this columnmin
- the minmax
- the maxquantiles
- 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 completeeventTime
- the time the event occured atrun
- the runjob
- the jobinputs
- The set of **input** datasets.outputs
- The set of **output** datasets.- Returns:
- RunEvent
-
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
-
newInputDatasetInputFacets
public OpenLineage.InputDatasetInputFacets newInputDatasetInputFacets(OpenLineage.DataQualityMetricsInputDatasetFacet dataQualityMetrics)- Parameters:
dataQualityMetrics
- the dataQualityMetrics- Returns:
- InputDatasetInputFacets
-
newInputDatasetInputFacetsBuilder
-