Package io.openlineage.client

Class OpenLineage

  • public final class OpenLineage
extends java.lang.Object
    Usage: 
    
   URI producer = URI.create("http://my.producer/uri");
   OpenLineage ol = new OpenLineage(producer);
   UUID runId = UUID.randomUUID();
   RunFacets runFacets =
     ol.newRunFacetsBuilder().nominalTime(ol.newNominalTimeRunFacet(now, now)).build();
   Run run = ol.newRun(runId, runFacets);
   String name = "jobName";
   String namespace = "namespace";
   JobFacets jobFacets = ol.newJobFacetsBuilder().build();
   Job job = ol.newJob(namespace, name, jobFacets);
   List<InputDataset> inputs = Arrays.asList(ol.newInputDataset("ins", "input", null, null));
   List<OutputDataset> outputs = Arrays.asList(ol.newOutputDataset("ons", "output", null, null));
   RunEvent runStateUpdate =
     ol.newRunEvent(now, OpenLineage.RunEvent.EventType.START, run, job, inputs, outputs);

    • Constructor Detail

      • OpenLineage

        public OpenLineage​(java.net.URI producer)
        Starting point to create OpenLineage objects. Use the OpenLineage instance to create events and facets
        Parameters:
        producer - the identifier of the library using the client to generate OpenLineage events

    • 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)
        Factory method for RunEvent
        Parameters:
        eventTime - the time the event occurred at
        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
        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()
        Creates a builder for RunEvent
        Returns:
        a new builder for RunEvent

      • newSchemaDatasetFacetFields

        public OpenLineage.SchemaDatasetFacetFields newSchemaDatasetFacetFields​(java.lang.String name,
                                                                        java.lang.String type,
                                                                        java.lang.String description,
                                                                        java.util.List<OpenLineage.SchemaDatasetFacetFields> fields)
        Factory method for SchemaDatasetFacetFields
        Parameters:
        name - The name of the field.
        type - The type of the field.
        description - The description of the field.
        fields - Nested struct fields.
        Returns:
        SchemaDatasetFacetFields

      • newSchemaDatasetFacetFieldsBuilder

        public OpenLineage.SchemaDatasetFacetFieldsBuilder newSchemaDatasetFacetFieldsBuilder()
        Creates a builder for SchemaDatasetFacetFields
        Returns:
        a new builder for SchemaDatasetFacetFields

      • newParentRunFacetBuilder

        public OpenLineage.ParentRunFacetBuilder newParentRunFacetBuilder()
        Creates a builder for ParentRunFacet
        Returns:
        a new builder for ParentRunFacet

      • newOutputStatisticsOutputDatasetFacet

        public OpenLineage.OutputStatisticsOutputDatasetFacet newOutputStatisticsOutputDatasetFacet​(java.lang.Long rowCount,
                                                                                            java.lang.Long size,
                                                                                            java.lang.Long fileCount)
        Factory method for OutputStatisticsOutputDatasetFacet
        Parameters:
        rowCount - The number of rows written to the dataset
        size - The size in bytes written to the dataset
        fileCount - The number of files written to the dataset
        Returns:
        OutputStatisticsOutputDatasetFacet

      • newOutputStatisticsOutputDatasetFacetBuilder

        public OpenLineage.OutputStatisticsOutputDatasetFacetBuilder newOutputStatisticsOutputDatasetFacetBuilder()
        Creates a builder for OutputStatisticsOutputDatasetFacet
        Returns:
        a new builder for OutputStatisticsOutputDatasetFacet

      • newExtractionErrorRunFacetErrors

        public OpenLineage.ExtractionErrorRunFacetErrors newExtractionErrorRunFacetErrors​(java.lang.String errorMessage,
                                                                                  java.lang.String stackTrace,
                                                                                  java.lang.String task,
                                                                                  java.lang.Long taskNumber)
        Factory method for ExtractionErrorRunFacetErrors
        Parameters:
        errorMessage - Text representation of extraction error message.
        stackTrace - Stack trace of extraction error message
        task - 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()
        Creates a builder for ExtractionErrorRunFacetErrors
        Returns:
        a new builder for ExtractionErrorRunFacetErrors

      • newJobTypeJobFacet

        public OpenLineage.JobTypeJobFacet newJobTypeJobFacet​(java.lang.String processingType,
                                                      java.lang.String integration,
                                                      java.lang.String jobType)
        Factory method for JobTypeJobFacet
        Parameters:
        processingType - Job processing type like: BATCH or STREAMING
        integration - OpenLineage integration type of this job: for example SPARK|DBT|AIRFLOW|FLINK
        jobType - Run type, for example: QUERY|COMMAND|DAG|TASK|JOB|MODEL. This is an integration-specific field.
        Returns:
        JobTypeJobFacet

      • newJobTypeJobFacetBuilder

        public OpenLineage.JobTypeJobFacetBuilder newJobTypeJobFacetBuilder()
        Creates a builder for JobTypeJobFacet
        Returns:
        a new builder for JobTypeJobFacet

      • newRun

        public OpenLineage.Run newRun​(java.util.UUID runId,
                              OpenLineage.RunFacets facets)
        Factory method for Run
        Parameters:
        runId - The globally unique ID of the run associated with the job.
        facets - The run facets.
        Returns:
        Run

      • newRunBuilder

        public OpenLineage.RunBuilder newRunBuilder()
        Creates a builder for Run
        Returns:
        a new builder for Run

      • newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles

        public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles()
        Factory method for DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles
        Returns:
        DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles

      • newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder

        public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder newDataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantilesBuilder()
        Creates a builder for DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles
        Returns:
        a new builder for DataQualityMetricsInputDatasetFacetColumnMetricsAdditionalQuantiles

      • newExternalQueryRunFacet

        public OpenLineage.ExternalQueryRunFacet newExternalQueryRunFacet​(java.lang.String externalQueryId,
                                                                  java.lang.String source)
        Factory method for ExternalQueryRunFacet
        Parameters:
        externalQueryId - Identifier for the external system
        source - source of the external query
        Returns:
        ExternalQueryRunFacet

      • newExternalQueryRunFacetBuilder

        public OpenLineage.ExternalQueryRunFacetBuilder newExternalQueryRunFacetBuilder()
        Creates a builder for ExternalQueryRunFacet
        Returns:
        a new builder for ExternalQueryRunFacet

      • newOutputDatasetOutputFacetsBuilder

        public OpenLineage.OutputDatasetOutputFacetsBuilder newOutputDatasetOutputFacetsBuilder()
        Creates a builder for OutputDatasetOutputFacets
        Returns:
        a new builder for OutputDatasetOutputFacets

      • newNominalTimeRunFacet

        public OpenLineage.NominalTimeRunFacet newNominalTimeRunFacet​(java.time.ZonedDateTime nominalStartTime,
                                                              java.time.ZonedDateTime nominalEndTime)
        Factory method for NominalTimeRunFacet
        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()
        Creates a builder for NominalTimeRunFacet
        Returns:
        a new builder for NominalTimeRunFacet

      • newOwnershipJobFacetOwners

        public OpenLineage.OwnershipJobFacetOwners newOwnershipJobFacetOwners​(java.lang.String name,
                                                                      java.lang.String type)
        Factory method for OwnershipJobFacetOwners
        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:data
        type - The type of ownership (optional)
        Returns:
        OwnershipJobFacetOwners

      • newOwnershipJobFacetOwnersBuilder

        public OpenLineage.OwnershipJobFacetOwnersBuilder newOwnershipJobFacetOwnersBuilder()
        Creates a builder for OwnershipJobFacetOwners
        Returns:
        a new builder for OwnershipJobFacetOwners

      • newJobEventBuilder

        public OpenLineage.JobEventBuilder newJobEventBuilder()
        Creates a builder for JobEvent
        Returns:
        a new builder for JobEvent

      • newColumnLineageDatasetFacetFieldsAdditional

        public OpenLineage.ColumnLineageDatasetFacetFieldsAdditional newColumnLineageDatasetFacetFieldsAdditional​(java.util.List<OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFields> inputFields,
                                                                                                          java.lang.String transformationDescription,
                                                                                                          java.lang.String transformationType)
        Factory method for ColumnLineageDatasetFacetFieldsAdditional
        Parameters:
        inputFields - the inputFields
        transformationDescription - a string representation of the transformation applied
        transformationType - 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()
        Creates a builder for ColumnLineageDatasetFacetFieldsAdditional
        Returns:
        a new builder for ColumnLineageDatasetFacetFieldsAdditional

      • newExtractionErrorRunFacet

        public OpenLineage.ExtractionErrorRunFacet newExtractionErrorRunFacet​(java.lang.Long totalTasks,
                                                                      java.lang.Long failedTasks,
                                                                      java.util.List<OpenLineage.ExtractionErrorRunFacetErrors> errors)
        Factory method for ExtractionErrorRunFacet
        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()
        Creates a builder for ExtractionErrorRunFacet
        Returns:
        a new builder for ExtractionErrorRunFacet

      • newOwnershipDatasetFacetOwners

        public OpenLineage.OwnershipDatasetFacetOwners newOwnershipDatasetFacetOwners​(java.lang.String name,
                                                                              java.lang.String type)
        Factory method for OwnershipDatasetFacetOwners
        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:data
        type - The type of ownership (optional)
        Returns:
        OwnershipDatasetFacetOwners

      • newOwnershipDatasetFacetOwnersBuilder

        public OpenLineage.OwnershipDatasetFacetOwnersBuilder newOwnershipDatasetFacetOwnersBuilder()
        Creates a builder for OwnershipDatasetFacetOwners
        Returns:
        a new builder for OwnershipDatasetFacetOwners

      • 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)
        Factory method for DataQualityMetricsInputDatasetFacetColumnMetricsAdditional
        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()
        Creates a builder for DataQualityMetricsInputDatasetFacetColumnMetricsAdditional
        Returns:
        a new builder for DataQualityMetricsInputDatasetFacetColumnMetricsAdditional

      • newDataQualityMetricsInputDatasetFacetColumnMetrics

        public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetrics newDataQualityMetricsInputDatasetFacetColumnMetrics()
        Factory method for DataQualityMetricsInputDatasetFacetColumnMetrics
        Returns:
        DataQualityMetricsInputDatasetFacetColumnMetrics

      • newDataQualityMetricsInputDatasetFacetColumnMetricsBuilder

        public OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetricsBuilder newDataQualityMetricsInputDatasetFacetColumnMetricsBuilder()
        Creates a builder for DataQualityMetricsInputDatasetFacetColumnMetrics
        Returns:
        a new builder for DataQualityMetricsInputDatasetFacetColumnMetrics

      • newDataQualityMetricsInputDatasetFacet

        public OpenLineage.DataQualityMetricsInputDatasetFacet newDataQualityMetricsInputDatasetFacet​(java.lang.Long rowCount,
                                                                                              java.lang.Long bytes,
                                                                                              java.lang.Long fileCount,
                                                                                              OpenLineage.DataQualityMetricsInputDatasetFacetColumnMetrics columnMetrics)
        Factory method for DataQualityMetricsInputDatasetFacet
        Parameters:
        rowCount - The number of rows evaluated
        bytes - The size in bytes
        fileCount - The number of files evaluated
        columnMetrics - The property key is the column name
        Returns:
        DataQualityMetricsInputDatasetFacet

      • newDataQualityMetricsInputDatasetFacetBuilder

        public OpenLineage.DataQualityMetricsInputDatasetFacetBuilder newDataQualityMetricsInputDatasetFacetBuilder()
        Creates a builder for DataQualityMetricsInputDatasetFacet
        Returns:
        a new builder for DataQualityMetricsInputDatasetFacet

      • newDocumentationJobFacet

        public OpenLineage.DocumentationJobFacet newDocumentationJobFacet​(java.lang.String description)
        Factory method for DocumentationJobFacet
        Parameters:
        description - The description of the job.
        Returns:
        DocumentationJobFacet

      • newDocumentationJobFacetBuilder

        public OpenLineage.DocumentationJobFacetBuilder newDocumentationJobFacetBuilder()
        Creates a builder for DocumentationJobFacet
        Returns:
        a new builder for DocumentationJobFacet

      • newGcpCommonJobFacetBuilder

        public OpenLineage.GcpCommonJobFacetBuilder newGcpCommonJobFacetBuilder()
        Creates a builder for GcpCommonJobFacet
        Returns:
        a new builder for GcpCommonJobFacet

      • newJobFacetsBuilder

        public OpenLineage.JobFacetsBuilder newJobFacetsBuilder()
        Creates a builder for JobFacets
        Returns:
        a new builder for JobFacets

      • newInputDatasetInputFacetsBuilder

        public OpenLineage.InputDatasetInputFacetsBuilder newInputDatasetInputFacetsBuilder()
        Creates a builder for InputDatasetInputFacets
        Returns:
        a new builder for InputDatasetInputFacets

      • newOwnershipDatasetFacetBuilder

        public OpenLineage.OwnershipDatasetFacetBuilder newOwnershipDatasetFacetBuilder()
        Creates a builder for OwnershipDatasetFacet
        Returns:
        a new builder for OwnershipDatasetFacet

      • newSQLJobFacet

        public OpenLineage.SQLJobFacet newSQLJobFacet​(java.lang.String query)
        Factory method for SQLJobFacet
        Parameters:
        query - the query
        Returns:
        SQLJobFacet

      • newSQLJobFacetBuilder

        public OpenLineage.SQLJobFacetBuilder newSQLJobFacetBuilder()
        Creates a builder for SQLJobFacet
        Returns:
        a new builder for SQLJobFacet

      • newDatasetFacetsBuilder

        public OpenLineage.DatasetFacetsBuilder newDatasetFacetsBuilder()
        Creates a builder for DatasetFacets
        Returns:
        a new builder for DatasetFacets

      • newOwnershipJobFacetBuilder

        public OpenLineage.OwnershipJobFacetBuilder newOwnershipJobFacetBuilder()
        Creates a builder for OwnershipJobFacet
        Returns:
        a new builder for OwnershipJobFacet

      • newParentRunFacetJob

        public OpenLineage.ParentRunFacetJob newParentRunFacetJob​(java.lang.String namespace,
                                                          java.lang.String name)
        Factory method for ParentRunFacetJob
        Parameters:
        namespace - The namespace containing that job
        name - The unique name for that job within that namespace
        Returns:
        ParentRunFacetJob

      • newParentRunFacetJobBuilder

        public OpenLineage.ParentRunFacetJobBuilder newParentRunFacetJobBuilder()
        Creates a builder for ParentRunFacetJob
        Returns:
        a new builder for ParentRunFacetJob

      • newOutputDataset

        public OpenLineage.OutputDataset newOutputDataset​(java.lang.String namespace,
                                                  java.lang.String name,
                                                  OpenLineage.DatasetFacets facets,
                                                  OpenLineage.OutputDatasetOutputFacets outputFacets)
        Factory method for OutputDataset
        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()
        Creates a builder for OutputDataset
        Returns:
        a new builder for OutputDataset

      • newErrorMessageRunFacet

        public OpenLineage.ErrorMessageRunFacet newErrorMessageRunFacet​(java.lang.String message,
                                                                java.lang.String programmingLanguage,
                                                                java.lang.String stackTrace)
        Factory method for ErrorMessageRunFacet
        Parameters:
        message - A human-readable string representing error message generated by observed system
        programmingLanguage - Programming language the observed system uses.
        stackTrace - A language-specific stack trace generated by observed system
        Returns:
        ErrorMessageRunFacet

      • newErrorMessageRunFacetBuilder

        public OpenLineage.ErrorMessageRunFacetBuilder newErrorMessageRunFacetBuilder()
        Creates a builder for ErrorMessageRunFacet
        Returns:
        a new builder for ErrorMessageRunFacet

      • newRunFacetsBuilder

        public OpenLineage.RunFacetsBuilder newRunFacetsBuilder()
        Creates a builder for RunFacets
        Returns:
        a new builder for RunFacets

      • newSchemaDatasetFacetBuilder

        public OpenLineage.SchemaDatasetFacetBuilder newSchemaDatasetFacetBuilder()
        Creates a builder for SchemaDatasetFacet
        Returns:
        a new builder for SchemaDatasetFacet

      • newGcpCommonJobFacetOrigin

        public OpenLineage.GcpCommonJobFacetOrigin newGcpCommonJobFacetOrigin​(java.lang.String sourceType,
                                                                      java.lang.String name)
        Factory method for GcpCommonJobFacetOrigin
        Parameters:
        sourceType - Type of the source. Possible values can be found in GCP documentation (https://cloud.google.com/data-catalog/docs/reference/data-lineage/rest/v1/projects.locations.processes#SourceType)
        name - If the sourceType isn't CUSTOM, the value of this field should be a GCP resource name of the system, which reports lineage. The project and location parts of the resource name must match the project and location of the lineage resource being created. More details in GCP documentation https://cloud.google.com/data-catalog/docs/reference/data-lineage/rest/v1/projects.locations.processes#origin
        Returns:
        GcpCommonJobFacetOrigin

      • newGcpCommonJobFacetOriginBuilder

        public OpenLineage.GcpCommonJobFacetOriginBuilder newGcpCommonJobFacetOriginBuilder()
        Creates a builder for GcpCommonJobFacetOrigin
        Returns:
        a new builder for GcpCommonJobFacetOrigin

      • newSourceCodeJobFacet

        public OpenLineage.SourceCodeJobFacet newSourceCodeJobFacet​(java.lang.String language,
                                                            java.lang.String sourceCode)
        Factory method for SourceCodeJobFacet
        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()
        Creates a builder for SourceCodeJobFacet
        Returns:
        a new builder for SourceCodeJobFacet

      • newDocumentationDatasetFacet

        public OpenLineage.DocumentationDatasetFacet newDocumentationDatasetFacet​(java.lang.String description)
        Factory method for DocumentationDatasetFacet
        Parameters:
        description - The description of the dataset.
        Returns:
        DocumentationDatasetFacet

      • newDocumentationDatasetFacetBuilder

        public OpenLineage.DocumentationDatasetFacetBuilder newDocumentationDatasetFacetBuilder()
        Creates a builder for DocumentationDatasetFacet
        Returns:
        a new builder for DocumentationDatasetFacet

      • 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)
        Factory method for SourceCodeLocationJobFacet
        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()
        Creates a builder for SourceCodeLocationJobFacet
        Returns:
        a new builder for SourceCodeLocationJobFacet

      • newColumnLineageDatasetFacetBuilder

        public OpenLineage.ColumnLineageDatasetFacetBuilder newColumnLineageDatasetFacetBuilder()
        Creates a builder for ColumnLineageDatasetFacet
        Returns:
        a new builder for ColumnLineageDatasetFacet

      • newDataQualityAssertionsDatasetFacetBuilder

        public OpenLineage.DataQualityAssertionsDatasetFacetBuilder newDataQualityAssertionsDatasetFacetBuilder()
        Creates a builder for DataQualityAssertionsDatasetFacet
        Returns:
        a new builder for DataQualityAssertionsDatasetFacet

      • newDatasetEvent

        public OpenLineage.DatasetEvent newDatasetEvent​(java.time.ZonedDateTime eventTime,
                                                OpenLineage.StaticDataset dataset)
        Factory method for DatasetEvent
        Parameters:
        eventTime - the time the event occurred at
        dataset - the dataset
        Returns:
        DatasetEvent

      • newDatasetEventBuilder

        public OpenLineage.DatasetEventBuilder newDatasetEventBuilder()
        Creates a builder for DatasetEvent
        Returns:
        a new builder for DatasetEvent

      • newProcessingEngineRunFacet

        public OpenLineage.ProcessingEngineRunFacet newProcessingEngineRunFacet​(java.lang.String version,
                                                                        java.lang.String name,
                                                                        java.lang.String openlineageAdapterVersion)
        Factory method for ProcessingEngineRunFacet
        Parameters:
        version - Processing engine version. Might be Airflow or Spark version.
        name - Processing engine name, e.g. Airflow or Spark
        openlineageAdapterVersion - OpenLineage adapter package version. Might be e.g. OpenLineage Airflow integration package version
        Returns:
        ProcessingEngineRunFacet

      • newProcessingEngineRunFacetBuilder

        public OpenLineage.ProcessingEngineRunFacetBuilder newProcessingEngineRunFacetBuilder()
        Creates a builder for ProcessingEngineRunFacet
        Returns:
        a new builder for ProcessingEngineRunFacet

      • newLifecycleStateChangeDatasetFacetPreviousIdentifier

        public OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifier newLifecycleStateChangeDatasetFacetPreviousIdentifier​(java.lang.String name,
                                                                                                                            java.lang.String namespace)
        Factory method for LifecycleStateChangeDatasetFacetPreviousIdentifier
        Parameters:
        name - the name
        namespace - the namespace
        Returns:
        LifecycleStateChangeDatasetFacetPreviousIdentifier

      • newLifecycleStateChangeDatasetFacetPreviousIdentifierBuilder

        public OpenLineage.LifecycleStateChangeDatasetFacetPreviousIdentifierBuilder newLifecycleStateChangeDatasetFacetPreviousIdentifierBuilder()
        Creates a builder for LifecycleStateChangeDatasetFacetPreviousIdentifier
        Returns:
        a new builder for LifecycleStateChangeDatasetFacetPreviousIdentifier

      • newJob

        public OpenLineage.Job newJob​(java.lang.String namespace,
                              java.lang.String name,
                              OpenLineage.JobFacets facets)
        Factory method for Job
        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()
        Creates a builder for Job
        Returns:
        a new builder for Job

      • newDatasetVersionDatasetFacet

        public OpenLineage.DatasetVersionDatasetFacet newDatasetVersionDatasetFacet​(java.lang.String datasetVersion)
        Factory method for DatasetVersionDatasetFacet
        Parameters:
        datasetVersion - The version of the dataset.
        Returns:
        DatasetVersionDatasetFacet

      • newDatasetVersionDatasetFacetBuilder

        public OpenLineage.DatasetVersionDatasetFacetBuilder newDatasetVersionDatasetFacetBuilder()
        Creates a builder for DatasetVersionDatasetFacet
        Returns:
        a new builder for DatasetVersionDatasetFacet

      • newSymlinksDatasetFacetIdentifiers

        public OpenLineage.SymlinksDatasetFacetIdentifiers newSymlinksDatasetFacetIdentifiers​(java.lang.String namespace,
                                                                                      java.lang.String name,
                                                                                      java.lang.String type)
        Factory method for SymlinksDatasetFacetIdentifiers
        Parameters:
        namespace - The dataset namespace
        name - The dataset name
        type - Identifier type
        Returns:
        SymlinksDatasetFacetIdentifiers

      • newSymlinksDatasetFacetIdentifiersBuilder

        public OpenLineage.SymlinksDatasetFacetIdentifiersBuilder newSymlinksDatasetFacetIdentifiersBuilder()
        Creates a builder for SymlinksDatasetFacetIdentifiers
        Returns:
        a new builder for SymlinksDatasetFacetIdentifiers

      • newDataQualityAssertionsDatasetFacetAssertions

        public OpenLineage.DataQualityAssertionsDatasetFacetAssertions newDataQualityAssertionsDatasetFacetAssertions​(java.lang.String assertion,
                                                                                                              java.lang.Boolean success,
                                                                                                              java.lang.String column)
        Factory method for DataQualityAssertionsDatasetFacetAssertions
        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()
        Creates a builder for DataQualityAssertionsDatasetFacetAssertions
        Returns:
        a new builder for DataQualityAssertionsDatasetFacetAssertions

      • newColumnLineageDatasetFacetFieldsAdditionalInputFieldsBuilder

        public OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFieldsBuilder newColumnLineageDatasetFacetFieldsAdditionalInputFieldsBuilder()
        Creates a builder for ColumnLineageDatasetFacetFieldsAdditionalInputFields
        Returns:
        a new builder for ColumnLineageDatasetFacetFieldsAdditionalInputFields

      • newParentRunFacetRun

        public OpenLineage.ParentRunFacetRun newParentRunFacetRun​(java.util.UUID runId)
        Factory method for ParentRunFacetRun
        Parameters:
        runId - The globally unique ID of the run associated with the job.
        Returns:
        ParentRunFacetRun

      • newParentRunFacetRunBuilder

        public OpenLineage.ParentRunFacetRunBuilder newParentRunFacetRunBuilder()
        Creates a builder for ParentRunFacetRun
        Returns:
        a new builder for ParentRunFacetRun

      • newStaticDataset

        public OpenLineage.StaticDataset newStaticDataset​(java.lang.String namespace,
                                                  java.lang.String name,
                                                  OpenLineage.DatasetFacets facets)
        Factory method for StaticDataset
        Parameters:
        namespace - The namespace containing that dataset
        name - The unique name for that dataset within that namespace
        facets - The facets for this dataset
        Returns:
        StaticDataset

      • newStaticDatasetBuilder

        public OpenLineage.StaticDatasetBuilder newStaticDatasetBuilder()
        Creates a builder for StaticDataset
        Returns:
        a new builder for StaticDataset

      • newColumnLineageDatasetFacetFields

        public OpenLineage.ColumnLineageDatasetFacetFields newColumnLineageDatasetFacetFields()
        Factory method for ColumnLineageDatasetFacetFields
        Returns:
        ColumnLineageDatasetFacetFields

      • newColumnLineageDatasetFacetFieldsBuilder

        public OpenLineage.ColumnLineageDatasetFacetFieldsBuilder newColumnLineageDatasetFacetFieldsBuilder()
        Creates a builder for ColumnLineageDatasetFacetFields
        Returns:
        a new builder for ColumnLineageDatasetFacetFields

      • newSymlinksDatasetFacetBuilder

        public OpenLineage.SymlinksDatasetFacetBuilder newSymlinksDatasetFacetBuilder()
        Creates a builder for SymlinksDatasetFacet
        Returns:
        a new builder for SymlinksDatasetFacet

      • newColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformations

        public OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformations newColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformations​(java.lang.String type,
                                                                                                                                                              java.lang.String subtype,
                                                                                                                                                              java.lang.String description,
                                                                                                                                                              java.lang.Boolean masking)
        Factory method for ColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformations
        Parameters:
        type - The type of the transformation. Allowed values are: DIRECT, INDIRECT
        subtype - The subtype of the transformation
        description - a string representation of the transformation applied
        masking - is transformation masking the data or not
        Returns:
        ColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformations

      • newColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformationsBuilder

        public OpenLineage.ColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformationsBuilder newColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformationsBuilder()
        Creates a builder for ColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformations
        Returns:
        a new builder for ColumnLineageDatasetFacetFieldsAdditionalInputFieldsTransformations

      • newStorageDatasetFacet

        public OpenLineage.StorageDatasetFacet newStorageDatasetFacet​(java.lang.String storageLayer,
                                                              java.lang.String fileFormat)
        Factory method for StorageDatasetFacet
        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()
        Creates a builder for StorageDatasetFacet
        Returns:
        a new builder for StorageDatasetFacet

      • newInputDataset

        public OpenLineage.InputDataset newInputDataset​(java.lang.String namespace,
                                                java.lang.String name,
                                                OpenLineage.DatasetFacets facets,
                                                OpenLineage.InputDatasetInputFacets inputFacets)
        Factory method for InputDataset
        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()
        Creates a builder for InputDataset
        Returns:
        a new builder for InputDataset

      • newDatasourceDatasetFacet

        public OpenLineage.DatasourceDatasetFacet newDatasourceDatasetFacet​(java.lang.String name,
                                                                    java.net.URI uri)
        Factory method for DatasourceDatasetFacet
        Parameters:
        name - the name
        uri - the uri
        Returns:
        DatasourceDatasetFacet

      • newDatasourceDatasetFacetBuilder

        public OpenLineage.DatasourceDatasetFacetBuilder newDatasourceDatasetFacetBuilder()
        Creates a builder for DatasourceDatasetFacet
        Returns:
        a new builder for DatasourceDatasetFacet

      • newLifecycleStateChangeDatasetFacetBuilder

        public OpenLineage.LifecycleStateChangeDatasetFacetBuilder newLifecycleStateChangeDatasetFacetBuilder()
        Creates a builder for LifecycleStateChangeDatasetFacet
        Returns:
        a new builder for LifecycleStateChangeDatasetFacet