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 and Description
static interface	OpenLineage.BaseFacet
static interface	OpenLineage.Builder<T>
static class	OpenLineage.ColumnLineageDatasetFacet
class	OpenLineage.ColumnLineageDatasetFacetBuilder
static class	OpenLineage.ColumnLineageDatasetFacetFields
static class	OpenLineage.ColumnLineageDatasetFacetFieldsAdditional
static class	OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalBuilder
static class	OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFields
static class	OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFieldsBuilder
static class	OpenLineage.ColumnLineageDatasetFacetFieldsBuilder
static class	OpenLineage.DataQualityAssertionsDatasetFacet
static class	OpenLineage.DataQualityAssertionsDatasetFacetAssertions
static class	OpenLineage.DataQualityAssertionsDatasetFacetAssertionsBuilder
class	OpenLineage.DataQualityAssertionsDatasetFacetBuilder
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 interface	OpenLineage.DatasetFacet
static class	OpenLineage.DatasetFacets
static class	OpenLineage.DatasetFacetsBuilder
static class	OpenLineage.DatasetVersionDatasetFacet
class	OpenLineage.DatasetVersionDatasetFacetBuilder
static class	OpenLineage.DatasourceDatasetFacet
class	OpenLineage.DatasourceDatasetFacetBuilder
static class	OpenLineage.DefaultDatasetFacet
static class	OpenLineage.DefaultInputDatasetFacet
static class	OpenLineage.DefaultJobFacet
static class	OpenLineage.DefaultOutputDatasetFacet
static class	OpenLineage.DefaultRunFacet
static class	OpenLineage.DocumentationDatasetFacet
class	OpenLineage.DocumentationDatasetFacetBuilder
static class	OpenLineage.DocumentationJobFacet
class	OpenLineage.DocumentationJobFacetBuilder
static class	OpenLineage.InputDataset
static class	OpenLineage.InputDatasetBuilder
static interface	OpenLineage.InputDatasetFacet
static class	OpenLineage.InputDatasetInputFacets
static class	OpenLineage.InputDatasetInputFacetsBuilder
static class	OpenLineage.Job
static class	OpenLineage.JobBuilder
static interface	OpenLineage.JobFacet
static class	OpenLineage.JobFacets
static class	OpenLineage.JobFacetsBuilder
static class	OpenLineage.LifecycleStateChangeDatasetFacet
class	OpenLineage.LifecycleStateChangeDatasetFacetBuilder
static class	OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifier
static class	OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifierBuilder
static class	OpenLineage.NominalTimeRunFacet
class	OpenLineage.NominalTimeRunFacetBuilder
static class	OpenLineage.OutputDataset
static class	OpenLineage.OutputDatasetBuilder
static interface	OpenLineage.OutputDatasetFacet
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 interface	OpenLineage.RunFacet
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.SourceCodeJobFacet
class	OpenLineage.SourceCodeJobFacetBuilder
static class	OpenLineage.SourceCodeLocationJobFacet
class	OpenLineage.SourceCodeLocationJobFacetBuilder
static class	OpenLineage.SQLJobFacet
class	OpenLineage.SQLJobFacetBuilder
static class	OpenLineage.StorageDatasetFacet
class	OpenLineage.StorageDatasetFacetBuilder

Constructor Summary

Constructors

Constructor and Description
OpenLineage(java.net.URI producer)

Method Summary

Modifier and Type	Method and Description
OpenLineage.ColumnLineageDatasetFacet	newColumnLineageDatasetFacet(OpenLineage.ColumnLineageDatasetFacetFields fields)
OpenLineage.ColumnLineageDatasetFacetBuilder	newColumnLineageDatasetFacetBuilder()
OpenLineage.ColumnLineageDatasetFacetFields	newColumnLineageDatasetFacetFields()
OpenLineage.ColumnLineageDatasetFacetFieldsAdditional	newColumnLineageDatasetFacetFieldsAdditional(java.util.List<OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFields> inputFields)
OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalBuilder	newColumnLineageDatasetFacetFieldsAdditionalBuilder()
OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFields	newColumnLineageDatasetFacetFieldsAdditionalInputFields(java.lang.String namespace, java.lang.String name, java.lang.String field)
OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFieldsBuilder	newColumnLineageDatasetFacetFieldsAdditionalInputFieldsBuilder()
OpenLineage.ColumnLineageDatasetFacetFieldsBuilder	newColumnLineageDatasetFacetFieldsBuilder()
OpenLineage.DataQualityAssertionsDatasetFacet	newDataQualityAssertionsDatasetFacet(java.util.List<OpenLineage.DataQualityAssertionsDatasetFacetAssertions> assertions)
OpenLineage.DataQualityAssertionsDatasetFacetAssertions	newDataQualityAssertionsDatasetFacetAssertions(java.lang.String assertion, java.lang.Boolean success, java.lang.String column)
OpenLineage.DataQualityAssertionsDatasetFacetAssertionsBuilder	newDataQualityAssertionsDatasetFacetAssertionsBuilder()
OpenLineage.DataQualityAssertionsDatasetFacetBuilder	newDataQualityAssertionsDatasetFacetBuilder()
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.DatasetFacet	newDatasetFacet()
OpenLineage.DatasetFacets	newDatasetFacets(OpenLineage.DocumentationDatasetFacet documentation, OpenLineage.DatasourceDatasetFacet dataSource, OpenLineage.DatasetVersionDatasetFacet version, OpenLineage.SchemaDatasetFacet schema, OpenLineage.StorageDatasetFacet storage, OpenLineage.ColumnLineageDatasetFacet columnLineage, OpenLineage.LifecycleStateChangeDatasetFacet lifecycleStateChange)
OpenLineage.DatasetFacetsBuilder	newDatasetFacetsBuilder()
OpenLineage.DatasetVersionDatasetFacet	newDatasetVersionDatasetFacet(java.lang.String datasetVersion)
OpenLineage.DatasetVersionDatasetFacetBuilder	newDatasetVersionDatasetFacetBuilder()
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.InputDatasetFacet	newInputDatasetFacet()
OpenLineage.InputDatasetInputFacets	newInputDatasetInputFacets(OpenLineage.DataQualityAssertionsDatasetFacet dataQualityAssertions, OpenLineage.DataQualityMetricsInputDatasetFacet dataQualityMetrics)
OpenLineage.InputDatasetInputFacetsBuilder	newInputDatasetInputFacetsBuilder()
OpenLineage.Job	newJob(java.lang.String namespace, java.lang.String name, OpenLineage.JobFacets facets)
OpenLineage.JobBuilder	newJobBuilder()
OpenLineage.JobFacet	newJobFacet()
OpenLineage.JobFacets	newJobFacets(OpenLineage.SourceCodeJobFacet sourceCode, OpenLineage.SQLJobFacet sql, OpenLineage.SourceCodeLocationJobFacet sourceCodeLocation, OpenLineage.DocumentationJobFacet documentation)
OpenLineage.JobFacetsBuilder	newJobFacetsBuilder()
OpenLineage.LifecycleStateChangeDatasetFacet	newLifecycleStateChangeDatasetFacet(OpenLineage.LifecycleStateChangeDatasetFacet.LifecycleStateChange lifecycleStateChange, OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifier previousIdentifier)
OpenLineage.LifecycleStateChangeDatasetFacetBuilder	newLifecycleStateChangeDatasetFacetBuilder()
OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifier	newLifecycleStateChangeDatasetFacetPreviousIdentifier(java.lang.String name, java.lang.String namespace)
OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifierBuilder	newLifecycleStateChangeDatasetFacetPreviousIdentifierBuilder()
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.OutputDatasetFacet	newOutputDatasetFacet()
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(OpenLineage.RunEvent.EventType 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.RunFacet	newRunFacet()
OpenLineage.RunFacets	newRunFacets(OpenLineage.ParentRunFacet parent, OpenLineage.NominalTimeRunFacet nominalTime)
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.SourceCodeJobFacet	newSourceCodeJobFacet(java.lang.String language, java.lang.String sourceCode)
OpenLineage.SourceCodeJobFacetBuilder	newSourceCodeJobFacetBuilder()
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()
OpenLineage.StorageDatasetFacet	newStorageDatasetFacet(java.lang.String storageLayer, java.lang.String fileFormat)
OpenLineage.StorageDatasetFacetBuilder	newStorageDatasetFacetBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenLineage

public OpenLineage(java.net.URI producer)

Method Detail

newRunEvent

public OpenLineage.RunEvent newRunEvent(OpenLineage.RunEvent.EventType 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 occurred 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()

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()

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()

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()

newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles

public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles()

Returns:

DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles

newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder

public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder()

newOutputDatasetOutputFacets

public OpenLineage.OutputDatasetOutputFacets newOutputDatasetOutputFacets(OpenLineage.OutputStatisticsOutputDatasetFacet outputStatistics)

Parameters:

outputStatistics - the outputStatistics

Returns:

OutputDatasetOutputFacets

newOutputDatasetOutputFacetsBuilder

public OpenLineage.OutputDatasetOutputFacetsBuilder newOutputDatasetOutputFacetsBuilder()

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()

newRunFacet

public OpenLineage.RunFacet newRunFacet()

Returns:

RunFacet

newInputDatasetFacet

public OpenLineage.InputDatasetFacet newInputDatasetFacet()

Returns:

InputDatasetFacet

newColumnLineageDatasetFacetFieldsAdditional

public OpenLineage.ColumnLineageDatasetFacetFieldsAdditional newColumnLineageDatasetFacetFieldsAdditional(java.util.List<OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFields> inputFields)

Parameters:

inputFields - the inputFields

Returns:

ColumnLineageDatasetFacetFieldsAdditional

newColumnLineageDatasetFacetFieldsAdditionalBuilder

public OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalBuilder newColumnLineageDatasetFacetFieldsAdditionalBuilder()

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()

newDataQualityMetricsInputDatasetFacetColumnMetrics

public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetrics newDataQualityMetricsInputDatasetFacetColumnMetrics()

Returns:

DataQualityMetricsInputDatasetFacetColumnMetrics

newDataQualityMetricsInputDatasetFacetColumnMetricsBuilder

public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsBuilder newDataQualityMetricsInputDatasetFacetColumnMetricsBuilder()

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()

newDocumentationJobFacet

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

Parameters:

description - The description of the job.

Returns:

DocumentationJobFacet

newDocumentationJobFacetBuilder

public OpenLineage.DocumentationJobFacetBuilder newDocumentationJobFacetBuilder()

newJobFacets

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

Parameters:

sourceCode - the sourceCode

sql - the sql

sourceCodeLocation - the sourceCodeLocation

documentation - the documentation

Returns:

JobFacets

newJobFacetsBuilder

public OpenLineage.JobFacetsBuilder newJobFacetsBuilder()

newInputDatasetInputFacets

public OpenLineage.InputDatasetInputFacets newInputDatasetInputFacets(OpenLineage.DataQualityAssertionsDatasetFacet dataQualityAssertions,
                                                                      OpenLineage.DataQualityMetricsInputDatasetFacet dataQualityMetrics)

Parameters:

dataQualityAssertions - the dataQualityAssertions

dataQualityMetrics - the dataQualityMetrics

Returns:

InputDatasetInputFacets

newInputDatasetInputFacetsBuilder

public OpenLineage.InputDatasetInputFacetsBuilder newInputDatasetInputFacetsBuilder()

newDatasetFacet

public OpenLineage.DatasetFacet newDatasetFacet()

Returns:

DatasetFacet

newSQLJobFacet

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

Parameters:

query - the query

Returns:

SQLJobFacet

newSQLJobFacetBuilder

public OpenLineage.SQLJobFacetBuilder newSQLJobFacetBuilder()

newDatasetFacets

public OpenLineage.DatasetFacets newDatasetFacets(OpenLineage.DocumentationDatasetFacet documentation,
                                                  OpenLineage.DatasourceDatasetFacet dataSource,
                                                  OpenLineage.DatasetVersionDatasetFacet version,
                                                  OpenLineage.SchemaDatasetFacet schema,
                                                  OpenLineage.StorageDatasetFacet storage,
                                                  OpenLineage.ColumnLineageDatasetFacet columnLineage,
                                                  OpenLineage.LifecycleStateChangeDatasetFacet lifecycleStateChange)

Parameters:

documentation - the documentation

dataSource - the dataSource

version - the version

schema - the schema

storage - the storage

columnLineage - the columnLineage

lifecycleStateChange - the lifecycleStateChange

Returns:

DatasetFacets

newDatasetFacetsBuilder

public OpenLineage.DatasetFacetsBuilder newDatasetFacetsBuilder()

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()

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()

newJobFacet

public OpenLineage.JobFacet newJobFacet()

Returns:

JobFacet

newRunFacets

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

Parameters:

parent - the parent

nominalTime - the nominalTime

Returns:

RunFacets

newRunFacetsBuilder

public OpenLineage.RunFacetsBuilder newRunFacetsBuilder()

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()

newSourceCodeJobFacet

public OpenLineage.SourceCodeJobFacet newSourceCodeJobFacet(java.lang.String language,
                                                            java.lang.String sourceCode)

Parameters:

language - Language in which source code of this job was written.

sourceCode - Source code of this job.

Returns:

SourceCodeJobFacet

newSourceCodeJobFacetBuilder

public OpenLineage.SourceCodeJobFacetBuilder newSourceCodeJobFacetBuilder()

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()

newColumnLineageDatasetFacet

public OpenLineage.ColumnLineageDatasetFacet newColumnLineageDatasetFacet(OpenLineage.ColumnLineageDatasetFacetFields fields)

Parameters:

fields - Column level lineage that maps output fields into input fields used to evaluate them.

Returns:

ColumnLineageDatasetFacet

newColumnLineageDatasetFacetBuilder

public OpenLineage.ColumnLineageDatasetFacetBuilder newColumnLineageDatasetFacetBuilder()

newDataQualityAssertionsDatasetFacet

public OpenLineage.DataQualityAssertionsDatasetFacet newDataQualityAssertionsDatasetFacet(java.util.List<OpenLineage.DataQualityAssertionsDatasetFacetAssertions> assertions)

Parameters:

assertions - the assertions

Returns:

DataQualityAssertionsDatasetFacet

newDataQualityAssertionsDatasetFacetBuilder

public OpenLineage.DataQualityAssertionsDatasetFacetBuilder newDataQualityAssertionsDatasetFacetBuilder()

newLifecycleStateChangeDatasetFacetPreviousIdentifier

public OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifier newLifecycleStateChangeDatasetFacetPreviousIdentifier(java.lang.String name,
                                                                                                                            java.lang.String namespace)

Parameters:

name - the name

namespace - the namespace

Returns:

LifecycleStateChangeDatasetFacetPreviousIdentifier

newLifecycleStateChangeDatasetFacetPreviousIdentifierBuilder

public OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifierBuilder newLifecycleStateChangeDatasetFacetPreviousIdentifierBuilder()

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()

newDatasetVersionDatasetFacet

public OpenLineage.DatasetVersionDatasetFacet newDatasetVersionDatasetFacet(java.lang.String datasetVersion)

Parameters:

datasetVersion - The version of the dataset.

Returns:

DatasetVersionDatasetFacet

newDatasetVersionDatasetFacetBuilder

public OpenLineage.DatasetVersionDatasetFacetBuilder newDatasetVersionDatasetFacetBuilder()

newDataQualityAssertionsDatasetFacetAssertions

public OpenLineage.DataQualityAssertionsDatasetFacetAssertions newDataQualityAssertionsDatasetFacetAssertions(java.lang.String assertion,
                                                                                                              java.lang.Boolean success,
                                                                                                              java.lang.String column)

Parameters:

assertion - Type of expectation test that dataset is subjected to

success - the success

column - Column that expectation is testing. It should match the name provided in SchemaDatasetFacet. If column field is empty, then expectation refers to whole dataset.

Returns:

DataQualityAssertionsDatasetFacetAssertions

newDataQualityAssertionsDatasetFacetAssertionsBuilder

public OpenLineage.DataQualityAssertionsDatasetFacetAssertionsBuilder newDataQualityAssertionsDatasetFacetAssertionsBuilder()

newColumnLineageDatasetFacetFieldsAdditionalInputFields

public OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFields newColumnLineageDatasetFacetFieldsAdditionalInputFields(java.lang.String namespace,
                                                                                                                                java.lang.String name,
                                                                                                                                java.lang.String field)

Parameters:

namespace - The input dataset namespace

name - The input dataset name

field - The input field

Returns:

ColumnLineageDatasetFacetFieldsAdditionalInputFields

newColumnLineageDatasetFacetFieldsAdditionalInputFieldsBuilder

public OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFieldsBuilder newColumnLineageDatasetFacetFieldsAdditionalInputFieldsBuilder()

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()

newOutputDatasetFacet

public OpenLineage.OutputDatasetFacet newOutputDatasetFacet()

Returns:

OutputDatasetFacet

newColumnLineageDatasetFacetFields

public OpenLineage.ColumnLineageDatasetFacetFields newColumnLineageDatasetFacetFields()

Returns:

ColumnLineageDatasetFacetFields

newColumnLineageDatasetFacetFieldsBuilder

public OpenLineage.ColumnLineageDatasetFacetFieldsBuilder newColumnLineageDatasetFacetFieldsBuilder()

newStorageDatasetFacet

public OpenLineage.StorageDatasetFacet newStorageDatasetFacet(java.lang.String storageLayer,
                                                              java.lang.String fileFormat)

Parameters:

storageLayer - Storage layer provider with allowed values: iceberg, delta.

fileFormat - File format with allowed values: parquet, orc, avro, json, csv, text, xml.

Returns:

StorageDatasetFacet

newStorageDatasetFacetBuilder

public OpenLineage.StorageDatasetFacetBuilder newStorageDatasetFacetBuilder()

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()

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()

newLifecycleStateChangeDatasetFacet

public OpenLineage.LifecycleStateChangeDatasetFacet newLifecycleStateChangeDatasetFacet(OpenLineage.LifecycleStateChangeDatasetFacet.LifecycleStateChange lifecycleStateChange,
                                                                                        OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifier previousIdentifier)

Parameters:

lifecycleStateChange - The lifecycle state change.

previousIdentifier - Previous name of the dataset in case of renaming it.

Returns:

LifecycleStateChangeDatasetFacet

newLifecycleStateChangeDatasetFacetBuilder

public OpenLineage.LifecycleStateChangeDatasetFacetBuilder newLifecycleStateChangeDatasetFacetBuilder()