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
-
-
-
Method Detail
-
newRunEvent
public OpenLineage.RunEvent newRunEvent(java.time.ZonedDateTime eventTime, OpenLineage.RunEvent.EventType eventType, OpenLineage.Run run, OpenLineage.Job job, java.util.List<OpenLineage.InputDataset> inputs, java.util.List<OpenLineage.OutputDataset> outputs)
- Parameters:
eventTime
- the time the event occurred ateventType
- 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 completerun
- the runjob
- the jobinputs
- 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 runjob
- 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 datasetsize
- The size in bytes written to the dataset- Returns:
- OutputStatisticsOutputDatasetFacet
-
newOutputStatisticsOutputDatasetFacetBuilder
public OpenLineage.OutputStatisticsOutputDatasetFacetBuilder newOutputStatisticsOutputDatasetFacetBuilder()
-
newExtractionErrorRunFacetErrors
public OpenLineage.ExtractionErrorRunFacetErrors newExtractionErrorRunFacetErrors(java.lang.String errorMessage, java.lang.String stackTrace, java.lang.String task, java.lang.Long taskNumber)
- Parameters:
errorMessage
- Text representation of extraction error message.stackTrace
- Stack trace of extraction error messagetask
- Text representation of task that failed. This can be, for example, SQL statement that parser could not interpret.taskNumber
- Order of task (counted from 0).- Returns:
- ExtractionErrorRunFacetErrors
-
newExtractionErrorRunFacetErrorsBuilder
public OpenLineage.ExtractionErrorRunFacetErrorsBuilder newExtractionErrorRunFacetErrorsBuilder()
-
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()
-
newExternalQueryRunFacet
public OpenLineage.ExternalQueryRunFacet newExternalQueryRunFacet(java.lang.String externalQueryId, java.lang.String source)
- Parameters:
externalQueryId
- Identifier for the external systemsource
- source of the external query- Returns:
- ExternalQueryRunFacet
-
newExternalQueryRunFacetBuilder
public OpenLineage.ExternalQueryRunFacetBuilder newExternalQueryRunFacetBuilder()
-
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 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
public OpenLineage.NominalTimeRunFacetBuilder newNominalTimeRunFacetBuilder()
-
newRunFacet
public OpenLineage.RunFacet newRunFacet()
- Returns:
- RunFacet
-
newOwnershipJobFacetOwners
public OpenLineage.OwnershipJobFacetOwners newOwnershipJobFacetOwners(java.lang.String name, java.lang.String type)
- Parameters:
name
- the identifier of the owner of the Job. It is recommended to define this as a URN. For example application:foo, user:jdoe, team:datatype
- The type of ownership (optional)- Returns:
- OwnershipJobFacetOwners
-
newOwnershipJobFacetOwnersBuilder
public OpenLineage.OwnershipJobFacetOwnersBuilder newOwnershipJobFacetOwnersBuilder()
-
newInputDatasetFacet
public OpenLineage.InputDatasetFacet newInputDatasetFacet()
- Returns:
- InputDatasetFacet
-
newJobEvent
public OpenLineage.JobEvent newJobEvent(java.time.ZonedDateTime eventTime, OpenLineage.Job job, java.util.List<OpenLineage.InputDataset> inputs, java.util.List<OpenLineage.OutputDataset> outputs)
- Parameters:
eventTime
- the time the event occurred atjob
- the jobinputs
- The set of **input** datasets.outputs
- The set of **output** datasets.- Returns:
- JobEvent
-
newJobEventBuilder
public OpenLineage.JobEventBuilder newJobEventBuilder()
-
newColumnLineageDatasetFacetFieldsAdditional
public OpenLineage.ColumnLineageDatasetFacetFieldsAdditional newColumnLineageDatasetFacetFieldsAdditional(java.util.List<OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFields> inputFields, java.lang.String transformationDescription, java.lang.String transformationType)
- Parameters:
inputFields
- the inputFieldstransformationDescription
- a string representation of the transformation appliedtransformationType
- IDENTITY|MASKED reflects a clearly defined behavior. IDENTITY: exact same as input; MASKED: no original data available (like a hash of PII for example)- Returns:
- ColumnLineageDatasetFacetFieldsAdditional
-
newColumnLineageDatasetFacetFieldsAdditionalBuilder
public OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalBuilder newColumnLineageDatasetFacetFieldsAdditionalBuilder()
-
newExtractionErrorRunFacet
public OpenLineage.ExtractionErrorRunFacet newExtractionErrorRunFacet(java.lang.Long totalTasks, java.lang.Long failedTasks, java.util.List<OpenLineage.ExtractionErrorRunFacetErrors> errors)
- Parameters:
totalTasks
- The number of distinguishable tasks in a run that were processed by OpenLineage, whether successfully or not. Those could be, for example, distinct SQL statements.failedTasks
- The number of distinguishable tasks in a run that were processed not successfully by OpenLineage. Those could be, for example, distinct SQL statements.errors
- the errors- Returns:
- ExtractionErrorRunFacet
-
newExtractionErrorRunFacetBuilder
public OpenLineage.ExtractionErrorRunFacetBuilder newExtractionErrorRunFacetBuilder()
-
newOwnershipDatasetFacetOwners
public OpenLineage.OwnershipDatasetFacetOwners newOwnershipDatasetFacetOwners(java.lang.String name, java.lang.String type)
- Parameters:
name
- the identifier of the owner of the Dataset. It is recommended to define this as a URN. For example application:foo, user:jdoe, team:datatype
- The type of ownership (optional)- Returns:
- OwnershipDatasetFacetOwners
-
newOwnershipDatasetFacetOwnersBuilder
public OpenLineage.OwnershipDatasetFacetOwnersBuilder newOwnershipDatasetFacetOwnersBuilder()
-
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()
-
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 evaluatedbytes
- The size in bytescolumnMetrics
- 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.OwnershipJobFacet ownership, OpenLineage.SQLJobFacet sql, OpenLineage.SourceCodeLocationJobFacet sourceCodeLocation, OpenLineage.DocumentationJobFacet documentation)
- Parameters:
sourceCode
- the sourceCodeownership
- the ownershipsql
- the sqlsourceCodeLocation
- the sourceCodeLocationdocumentation
- the documentation- Returns:
- JobFacets
-
newJobFacetsBuilder
public OpenLineage.JobFacetsBuilder newJobFacetsBuilder()
-
newInputDatasetInputFacets
public OpenLineage.InputDatasetInputFacets newInputDatasetInputFacets(OpenLineage.DataQualityAssertionsDatasetFacet dataQualityAssertions, OpenLineage.DataQualityMetricsInputDatasetFacet dataQualityMetrics)
- Parameters:
dataQualityAssertions
- the dataQualityAssertionsdataQualityMetrics
- the dataQualityMetrics- Returns:
- InputDatasetInputFacets
-
newInputDatasetInputFacetsBuilder
public OpenLineage.InputDatasetInputFacetsBuilder newInputDatasetInputFacetsBuilder()
-
newDatasetFacet
public OpenLineage.DatasetFacet newDatasetFacet()
- Returns:
- DatasetFacet
-
newOwnershipDatasetFacet
public OpenLineage.OwnershipDatasetFacet newOwnershipDatasetFacet(java.util.List<OpenLineage.OwnershipDatasetFacetOwners> owners)
- Parameters:
owners
- The owners of the dataset.- Returns:
- OwnershipDatasetFacet
-
newOwnershipDatasetFacetBuilder
public OpenLineage.OwnershipDatasetFacetBuilder newOwnershipDatasetFacetBuilder()
-
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.OwnershipDatasetFacet ownership, OpenLineage.StorageDatasetFacet storage, OpenLineage.ColumnLineageDatasetFacet columnLineage, OpenLineage.SymlinksDatasetFacet symlinks, OpenLineage.LifecycleStateChangeDatasetFacet lifecycleStateChange)
- Parameters:
documentation
- the documentationdataSource
- the dataSourceversion
- the versionschema
- the schemaownership
- the ownershipstorage
- the storagecolumnLineage
- the columnLineagesymlinks
- the symlinkslifecycleStateChange
- the lifecycleStateChange- Returns:
- DatasetFacets
-
newDatasetFacetsBuilder
public OpenLineage.DatasetFacetsBuilder newDatasetFacetsBuilder()
-
newOwnershipJobFacet
public OpenLineage.OwnershipJobFacet newOwnershipJobFacet(java.util.List<OpenLineage.OwnershipJobFacetOwners> owners)
- Parameters:
owners
- The owners of the job.- Returns:
- OwnershipJobFacet
-
newOwnershipJobFacetBuilder
public OpenLineage.OwnershipJobFacetBuilder newOwnershipJobFacetBuilder()
-
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
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 datasetname
- The unique name for that dataset within that namespacefacets
- The facets for this datasetoutputFacets
- The output facets for this dataset- Returns:
- OutputDataset
-
newOutputDatasetBuilder
public OpenLineage.OutputDatasetBuilder newOutputDatasetBuilder()
-
newErrorMessageRunFacet
public OpenLineage.ErrorMessageRunFacet newErrorMessageRunFacet(java.lang.String message, java.lang.String programmingLanguage, java.lang.String stackTrace)
- Parameters:
message
- A human-readable string representing error message generated by observed systemprogrammingLanguage
- Programming language the observed system uses.stackTrace
- A language-specific stack trace generated by observed system- Returns:
- ErrorMessageRunFacet
-
newErrorMessageRunFacetBuilder
public OpenLineage.ErrorMessageRunFacetBuilder newErrorMessageRunFacetBuilder()
-
newJobFacet
public OpenLineage.JobFacet newJobFacet()
- Returns:
- JobFacet
-
newRunFacets
public OpenLineage.RunFacets newRunFacets(OpenLineage.ErrorMessageRunFacet errorMessage, OpenLineage.ExternalQueryRunFacet externalQuery, OpenLineage.ExtractionErrorRunFacet extractionError, OpenLineage.ParentRunFacet parent, OpenLineage.NominalTimeRunFacet nominalTime, OpenLineage.ProcessingEngineRunFacet processing_engine)
- Parameters:
errorMessage
- the errorMessageexternalQuery
- the externalQueryextractionError
- the extractionErrorparent
- the parentnominalTime
- the nominalTimeprocessing_engine
- the processing_engine- 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 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
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()
-
newDatasetEvent
public OpenLineage.DatasetEvent newDatasetEvent(java.time.ZonedDateTime eventTime, OpenLineage.StaticDataset dataset)
- Parameters:
eventTime
- the time the event occurred atdataset
- the dataset- Returns:
- DatasetEvent
-
newDatasetEventBuilder
public OpenLineage.DatasetEventBuilder newDatasetEventBuilder()
-
newProcessingEngineRunFacet
public OpenLineage.ProcessingEngineRunFacet newProcessingEngineRunFacet(java.lang.String version, java.lang.String name, java.lang.String openlineageAdapterVersion)
- Parameters:
version
- Processing engine version. Might be Airflow or Spark version.name
- Processing engine name, e.g. Airflow or SparkopenlineageAdapterVersion
- OpenLineage adapter package version. Might be e.g. OpenLineage Airflow integration package version- Returns:
- ProcessingEngineRunFacet
-
newProcessingEngineRunFacetBuilder
public OpenLineage.ProcessingEngineRunFacetBuilder newProcessingEngineRunFacetBuilder()
-
newLifecycleStateChangeDatasetFacetPreviousIdentifier
public OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifier newLifecycleStateChangeDatasetFacetPreviousIdentifier(java.lang.String name, java.lang.String namespace)
- Parameters:
name
- the namenamespace
- 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 jobname
- The unique name for that job within that namespacefacets
- 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()
-
newSymlinksDatasetFacetIdentifiers
public OpenLineage.SymlinksDatasetFacetIdentifiers newSymlinksDatasetFacetIdentifiers(java.lang.String namespace, java.lang.String name, java.lang.String type)
- Parameters:
namespace
- The dataset namespacename
- The dataset nametype
- Identifier type- Returns:
- SymlinksDatasetFacetIdentifiers
-
newSymlinksDatasetFacetIdentifiersBuilder
public OpenLineage.SymlinksDatasetFacetIdentifiersBuilder newSymlinksDatasetFacetIdentifiersBuilder()
-
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 tosuccess
- the successcolumn
- 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 namespacename
- The input dataset namefield
- 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
-
newStaticDataset
public OpenLineage.StaticDataset newStaticDataset(java.lang.String namespace, java.lang.String name, OpenLineage.DatasetFacets facets)
- Parameters:
namespace
- The namespace containing that datasetname
- The unique name for that dataset within that namespacefacets
- The facets for this dataset- Returns:
- StaticDataset
-
newStaticDatasetBuilder
public OpenLineage.StaticDatasetBuilder newStaticDatasetBuilder()
-
newColumnLineageDatasetFacetFields
public OpenLineage.ColumnLineageDatasetFacetFields newColumnLineageDatasetFacetFields()
- Returns:
- ColumnLineageDatasetFacetFields
-
newColumnLineageDatasetFacetFieldsBuilder
public OpenLineage.ColumnLineageDatasetFacetFieldsBuilder newColumnLineageDatasetFacetFieldsBuilder()
-
newSymlinksDatasetFacet
public OpenLineage.SymlinksDatasetFacet newSymlinksDatasetFacet(java.util.List<OpenLineage.SymlinksDatasetFacetIdentifiers> identifiers)
- Parameters:
identifiers
- the identifiers- Returns:
- SymlinksDatasetFacet
-
newSymlinksDatasetFacetBuilder
public OpenLineage.SymlinksDatasetFacetBuilder newSymlinksDatasetFacetBuilder()
-
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 datasetname
- The unique name for that dataset within that namespacefacets
- The facets for this datasetinputFacets
- 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 nameuri
- 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()
-
-